C语言编程规范 v2.0

天正智能室C语言编程规范 v2.0

第一部分注释

第1.01条【强制】：注释的语言应统一，建议都使用中文注释，除非能用非常流利准确的英文表达。

第1.02条【强制】：注释格式应统一使用“/* …… */”。

第1.03条【强制】：注释应与其描述的代码接近，应放在其上或右方相邻位置，不可放在下面。放于代码右边的注释，应左右对齐。

第1.04条【强制】：注释与所描述内容进行同样的缩排，如果注释放于代码上方则需与其上面的代码用空行阁开。

第1.05条【强制】：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。

第1.06条【建议】：全局变量要有较详细的注释，包括对其功能、取值范围、存取时注意事项等的说明。

第1.07条【强制】：函数头部应有较详细注释，列出：函数功能、参数、返回值及注意事项等。

第1.08条【强制】：源文件注释必须列出版权说明、作者、版本号、生成日期、功能描述、修改日志。如果是单片机程序还需要指定编译环境，单片机型号或产品的电路原理图。

第二部分排版

第2.01条【强制】：程序块要采用缩进风格编写，缩进的空格数为4个。建议对齐只使用空格键，不使用TAB键。

第2.02条【强制】：变量说明之后、相对独立的程序块之间必须加空行。

第2.03条【强制】：不允许把多个短语句写在一行中，即一行只写一条语句。

第2.04条【强制】：if、for、do、while、case、switch、default等语句各自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

第2.05条【强制】：有较长的表达式、语句或参数，则要进行适应的划分，一行程序以80个左右的字符为宜，不要写得过长。

第2.06条【强制】：程序块的分界符‘{’和‘}’应各自独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、结构的定义、枚举的定义以及if、for、do、while、case语句中的程序都要采用如上的缩进方式。

第2.07条【强制】：为使关键词更加突显，if、for、do、while、case、switch、default等关键词与后面的括号间应加空格。

第2.08条【强制】：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如‘->’、‘.’、‘++’、‘--’），后不应加空格。

第三部分标示符命名

第3.01条【强制】：标识符的命名要清晰、明了，有明确含义；使用完整的单词或可理解的缩写；由于汉字拼音的多义性，如非必须不建议使用，禁止使用拼音缩写。

第3.02条【强制】：标示符的命名风格，应自始至终保持统一。

第3.03条【建议】：变量建议采用骆驼命名法，即首个字母小写的大小写混排方式；或者是帕斯卡命名法，即首个字母大写的大小写混排方式；或者UNIX风格，即各个单词小写加下划线方式。不管采用哪种命名方式，命名的风格必须保持统一。

第3.04条【建议】：函数采用帕斯卡命名法，即首个字母大写的大小写混排方式。

第3.05条【强制】：结构名的各单词的字母必须大写，单词间用下划线隔开，结构成员的命名与变量相同。

第3.06条【强制】：宏和常量的名称中，单词的字符必须大写，单词间用下划线阁开。

第3.07条【强制】：枚举和枚举成员名各单词都均为大写，单词间用下划线阁开，此外建议枚举成员名的第一个单词相同，便于多个枚举的区别。

第3.08条【建议】：同一模块的各个标示符可用本模块的名称的缩写做为前缀，以便于防止不同模块中有相同的标示符而产生冲突的可能。

第3.09条【建议】：全局变量建议用“g_”作为前缀，静态变量建议用“s_”做为前缀。