PDF《C 语言程序设计》

} 间隔: 所有的标识符都必须被空白字符包围. 例如: int theTick = 5;

[键入文字]

3 if (theTick == 5) 空行:代码段之间须以一个空行进行间隔;

空格的位置: 1)在一个关键字和左括号 ( 之间.注意:不要在函数名和左括号之 间加空格;

2)在参数列表的每个逗号 , 之后;

3)二元操作符前后.注意:一元操作符前后都不加空格.例如:int a = 10;

a = a + 1;

a++;

4)for 语句的每个表达式之间.例如:for (int i = 0;

i <

20;

i++)…. 代码行: 1)不允许把多个短语句写在一行中,即一行只写一条语句;

2)长语句、参数、表达式(超过

80 个ASCII 字符)应分行书写,操 作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可 读. 示例: #001 perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN #002 + STAT_SIZE_PER_FRAM ;

#003 act_task_table[STAT_TASK_CHECK_NUMBER + index].occupied #004 = stat_poi[index].occupied;

命名规则: 所有的标识符只能用字母(A-Z 或a-z)和数字(0-9) .不得包含货币 符号或其它非 AS-CII 字符. 1)变量的命名应尽可能采用有意义的名词,力求可顾名思义. 2)可以采用一个单词或多个单词的缩写作为名字,缩写单词的每个字 母都要大写. 3)对于难以使用英文的情况,可以参考相关行业标准,比如使用国标. 4)采用约定俗成的习惯用法. 常见的习惯用法: 循环变量:i、j、k、m、n 长度:length 数量:count 位置:pos 或position 下标或索引:i 或index 设置/获取:set/get 大小:size 注释: 1) 为确保程序易读性,注释语句不得小于全部代码行的 30%. 2) 说明性文件 (如头文件.h 文件、 .inc 文件、 .def 文件、 编译说明文件.cfg [键入文字]

4 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、 内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数 功能简要说明. 3) 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等. 4) 函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参 数、返回值、调用关系(函数、表)等. 5) 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代 码的一致性.不再有用的注释要删除. 6) 注释的内容要清楚、明了,含义准确,防止注释二义性. 7) 避免在注释中使用缩写,特别是非常用缩写. 8) 注释应与其描述的代码相近, 对代码的注释应放在其上方或右方 (对 单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代 码用空行隔开. 9) 对于所有有物理含义的变量、常量,如果其命名不是充分自注释的, 在声明时都必须加以注释,说明其物理含义.变量、常量、宏的注释应放在 其上方相邻位置或右方. 10) 数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充 分自注释的,必须加以注释.对结构中的每个域的注释放在此域的右方. 11) 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数 或过程存取它以及存取时注意事项等的说明. 12) 注释与所描述内容进行同样的缩排. 13) 将注释与其上面的代码用空行隔开. 14) 对变量的定义和分支语句 (条件分支、 循环语句等) 必须编写注释. 15) 对于 switch 语句下的 case 语句,如果因为特殊情况需要处理完一 个case 后进入下一个 case 处理,必须在该 case 语句处理完、下一个 case 语 句前加上明确的注释.