c编程规范文档(程序员必备)

《c编程规范文档(程序员必备)》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、目录一般原则…………………………………………………………………………………………………2标识符……………………………………………………………………………………………….4排版………………………………………………………………………………………………7注视………………………………………………………………………………………………10²采用与操作系统或开发工具的风格一致的标识符命名规则。²标识符一般由一个或多个单词组成。²变量命名禁止取单个字符。²不要仅依赖大小写来区分相似的标识符。²枚举、常量、宏的所有字母大写，用”_”分隔。²宏定义表达式时，注意使用完整的括号。²避免使用一个或

2、两个下划线开头的标识符。²程序块要采用缩进风格编写，缩进的空格数为4个。²在循环、判断等语句中，若有较长的表达式或语句，则要进行适应的划分，操作符放在新行之首。²若函数的参数较长，则要进行适当的划分。²不要把多条语句写在一行。²if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。²大括号”{“和“}”应各独占一行并且位于关键字的同一列。²对于switch语句的每一个分支，应该有break，必须有default分支。²在二元操作符的两侧添加空格，但”.”和“->”除外。²注释的内容要清楚、明了，含义准确，防止注释二义性。²写代码的

3、同时编写注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。²注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。²注释与所描述内容进行同样的缩进排版。²注释应考虑程序易读及外观排版的因素，只使用一种语言注释代码。²在每个文件的顶部添加文件说明。一般原则1.编写简单的代码。把复杂的语句和函数分解成更简单的片段。对复杂的逻辑要有明确的注释。2.显式的使用C/C++的特性。避免使用C/C++的隐含特性。例如：当进行数据类型强制转换时，其数据的意义、转换后的取值等都有可能发生变化。注意

4、运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认的优先级。若是这些细节若考虑不周，就很有可能留下隐患。例如：charhigh,low;shortword;word=high<<8

5、low;应该写成:word=((short)high<<8)

6、(short)low;3.改进模块结构，降低函数间的耦合度，并提高模块的独立性以及代码可读性、效率和可维护性。优化时，要遵守以下原则：1)限制函数的规模：函数的规模尽量限制在200行以内，过大的要进行分解；2)降低函数间接口的复杂度；3)提高函数内聚（单一功能的函数内聚最高）；4)数据结构设计要合理。要考虑向前兼容和以后版本的

7、升级，并为某些未来可能的应用预留一些空间等。例如：structFOO{chara;shortb;intc;chard;};结构体FOO的设计应该考虑数据对齐（在32位系统上一般是4字节对齐），还应预留将来升级的空间。结构体FOO可以设计成：structFOO{chara;chard;shortb;intc;intr[4];//Reserved.};4.检查函数所有输入参数和非输入参数（全局变量，数据文件等）的有效性。BOOLSetStreamType(HANDLEhChannel,STREAM_TYPEStreamType){if(NULL==hChannel){retur

8、nFALSE;}if(STREAM_TYPE_VIDEO!=StreamType

9、

10、STREAM_TYPE_AUDIO!=StreamType

11、

12、STREAM_TYPE_AVSYNC!=StreamType){returnFALSE;}//programcodereturnTRUE;}5.调用外部函数时，对返回值要做判断。对外提供的API函数要处理好函数的返回值。FILE*stream=fopen("crt_fopen.c","r");if(NULL==stream){printf("Thefile'crt_fopen.c'wasnotopened");}else{//

13、programcode}6.保持一致的风格。在一个项目中，标识符、排版、注释的风格保持前后一致。不要在前期使用一种风格后期又改变。7.编写代码时，要注意随时保存，并及时提交到服务器上。防止由于断电、硬盘损坏等原因造成代码丢失。标识符8.采用与操作系统或开发工具的风格一致的标识符命名规则。例如，Windows程序的标识符通常采用“大小写”混排的方式，如AddChild。而Unix/Linux程序的标识符通常采用“小写加下划线”的方式，如add_child。别把这两类风格混在一起用。最好使用完整的单词，或大家能够可以理