序号 总 则 条 款
执行情况
说明
1 排版
1 1 -1 :程序块要采用缩进风格编写,缩进的空格数为 4 个。
1 1 -2 :相对独立的程序块之间、变量说明之后必须加空行。
1 1 -3 :较长的语句( >80 字符)要分成多行书写, 长表达式要在低优先级操作符处划分
新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读 。
1 1 -4 :循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式
要在低优先级操作符处划分新行,操作符放在新行之首。
1 1 -5 :若函数或过程中的参数较长,则要进行适当的划分。
1 1 -6 :不允许把多个短语句写在一行中,即一行只写一条语句。
1 1 -7 : if 、 while 、 for 、 default 、 do 等语句自占一行。
1 1 -8 : 对齐只使用空格键,不使用 TAB 键 。
1 1-9 :函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,
case 语句下的情况处理语句也要遵从语句缩进要求。
1 1 -10:程序块的分界符(如 C/C++语言的大括号‘{‘和'}')应各独占一行并且位
于同一列,同时与引用它们的语句左对齐。 在函数体的开始、类的定义、结构的定义、枚举
的定义以及 if 、 for 、 do 、 while0 、 switch 、 case 语句中的程序都要采用如上的缩进方式。
1 1 -11 : 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、
之后或者前后要加空格; 进行非对等操作时, 如果是关系密切的立即操作符 (如- >) , 后不
应加空格。
2 注释
1 2-1 : 一般情况下,源程序有效注释量必须在 20%以上 。
1 2-2 : 说明性文件(如头文件 .h 文件、 .inc 文件、 .def 文件、编译说明文件 .cfg 等)头
部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它
文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明 。
1 2-3 : 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的 /
功能、主要函数及其功能、修改日志等 。
1 2-4 : 函数头部应进行注释,列出:函数的目的 / 功能、输入参数、输出参数、返回值、调
用关系(函数、表)等 。
1 2-5 : 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不
再有用的注释要删除 。
1 2-6 :注释的内容要清楚、明了,含义准确,防止注释二义性。
1 2-7 : 避免在注释中使用缩写,特别是非常用缩写 。
1 2-8 : 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注
释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开 。 1 2-9 : 对于
所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,
说明其物理含义 。变量、常量、宏的注释应放在其上方相邻位置或右方。
1 2-10 : 数据结构声明 ( 包括数组、结构、类、枚举等 ) ,如果其命名不是充分自注释的,必
须加以
CC编程准则 来自淘豆网m.daumloan.com转载请标明出处.