C C++语言编程规范

C C++语言编程规范

ID:41033123

大小:32.50 KB

页数:6页

时间:2019-08-14

C C++语言编程规范_第1页
C C++语言编程规范_第2页
C C++语言编程规范_第3页
C C++语言编程规范_第4页
C C++语言编程规范_第5页
资源描述:

《C C++语言编程规范》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库

1、C、C++语言编程规范一.目的  良好的编程风格是提高程序可靠性非常重要的手段,也是大型项目多人合作开发的技术基础。为了提高C/C++源程序的质量和可维护性,通过本规范定义来避免不好的编程风格,增强程序的易读性,便于自己及他人阅读。本规范的内容包括:排版、注释、标识符命名、可读性、变量、结构、函数、过程、可测性、质量保证等。二.排版1、相对独立的程序块之间要加空行分隔,在每个类声明之后、每个函数定义结束之后都要加空行,变量声明与执行代码之间加空行分隔(C++代码中变量声明与使用合在一起的可不加空行)。2、函数或过程的开始、类或结构的定义、

2、枚举的定义及循环、判断等语句中以及折行的代码都要采用缩进风格。每次缩进一个制表符宽度,或者缩进2个或4个空格宽度,代码中应统一使用制表符或空格来进行缩进,不可混用,否则在使用不同的源代码阅读工具时制表符将因为用户设置的不同而扩展为不同的宽度,造成显示混乱。制表符具有占用字节少、易定位、不容易错位(使用空格缩进容易出现多一个或少一个空格的现象,看上去不明显,但却是错位的)、扩展宽度可设置的优点,推荐使用。3、较长的语句(>80字符,或以编辑屏幕可见范围为准)要分成多行书写(折行),长表达式要在低优先级操作符处划分新行,操作符放在新行之首。4

3、、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。5、若函数或过程中的参数列表较长,则要进行适当的划分。6、特殊情况下,长代码的折行可采用灵活的方式,宗旨是使代码易读。7、划分出的新行要进行适当的缩进,以便识别。将一行代码划分为多行时,划分出的新行的缩进量要一致。8、一行代码只做一件事情,例如只定义一个变量,或只写一条语句,这样的代码容易阅读,并且方便于写注释。不允许把多个短语句写在一行中,特殊代码(例如宏)除外。9、if、for、do、while、case、swit

4、ch、default、continue、goto、extern、return、typedef等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要用大括号'{'和'}'括起来。10、C/C++语言是用大括号'{'和'}'界定一段程序块的,编写程序块时'{'和'}'应各独占一行并且位于同一列,同时与引用它们的语句左对齐。空函数或简单的内联函数除外。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。11、标识符和操作符之间加适

5、当的空格,使代码错落有致,容易阅读。一元运算符(++、--、求址符&、求值符*、求非值符!、求反值符~、表示正负的+、-等)紧贴操作数,不加空格;二元运算符(算术运算符+、-、*、/、%、位运算符&、

6、、^、移位符<<、>>、赋值符+=、-=、*=、/=、%=、&=、

7、=、^=、<<=、>>=、比较符&&、

8、

9、等)与前后的操作数之间各保留一个空格;逗号、分号紧跟前面的标识符,后面保留一个空格;类、结构成员访问符.、->等前后不加空格;声明函数和单个变量时,类型修饰符&和*靠近类型名,与函数名或变量名之间留一个空格;在一条语句中声明多个变量

10、时,类型修饰符&和*靠近变量名,避免阅读代码时产生误解。12、修改代码时排版风格应与原代码风格保持一致,或者彻底修改整份代码的风格(代码基线后不提倡这样大改)。三.注释1、源程序有效注释量必须在20%以上。注释应尽量采用C++的注释风格,即使用//注释。2、在代码的逻辑含义的层次上进行注释。注释总是加在程序的需要一个概括性说明或不易理解或易理解错的地方。注释语言应该简练、易懂而又含义准确,避免二义性;所采用的语种首选是中文,如有输入困难、编译环境限制或特殊需求也可采用英文。3、注释应与其描述的代码相近,对代码的注释应放在其上方或右方(针对

11、单条语句的注释)相邻位置,不可放在下方,避免在一行代码或表达式中间使用注释,如放于上方则需与其上面的代码用空行隔开(较紧凑的代码除外)。4、正确命名变量、结构、函数、过程以及合理地组织代码地结构,使代码成为自注释的,可减少不必要的注释。5、数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。6、在常量名字(或有宏机制的语言中的宏)声明后应对该名字作适当注释,注释说明的要点是:被保存值的含义(必须);合法取值的范围(可

12、选)。7、函数注释包括:函数功能描述(必须,除非函数非常简单明了),输入、输出等,复杂的函数需要加上变量用途说明。8、说明文件(.h、.inc、.def、.cfg等)头部应进行注释,注释内容包

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。