C语言编码规范.docx

C语言编码规范

1 :程序块要采用缩进风格编写，缩进的 TAB键一个。
2 :相对独立的程序块之间、变量说明之后必须加空行。
3:较长的语句（＞80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的 新行要进行适当的缩进，使排版整齐，语句可读。
4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作 符放在新行之首。
5：若函数或过程中的参数较长，则要进行适当的划分。
1-6 :不允许把多个短语句写在一行中，即一行只写一条语句。
1-7： if、while、for、default、do等语句自占一行。
1-8:对齐只使用TAB键，不使用空格键。
1-9 :函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格， case语句下的情况处理语句也要遵从
语句缩进要求。
1- 10:程序块的分界符（如 C/C++语言的大括号'{'和'}'）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在
函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while0、switch、case语句中的程序都要采用如上的缩
进方式。
1-11:在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操 作时，如果是关系密切的立即操作符（如一 ＞）,后不应加空格。
12:程序结构清析，简单易懂，单个函数的程序行数不得超过 100行。

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