程序编码规范

《程序编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、----------专业最好文档，专业为你服务，急你所急，供你所需-------------文档下载最佳的地方1.目的及适用范围本文档的目的是约束C程序员按照统一的风格命名模块名和编写程序，以提高软件产品的可读性和可维护性。本文档可以使程序员：l提供高质量的代码l减少维护自己代码的时间l减少重写继承代码的时间l共享应用程序逻辑和测试数据文件l迅速掌握一种编程风格l顺利通过代码检查CI(CodeInspections)2.编码风格及标准2.1.总体标准1.保持简单性：将过于复杂的语句分解，使用清晰的注释。2.保证明确性

2、：避免模糊性和二义性。如：a=5*6/7;/*使用()，不要依赖缺省编译！*/3.具有可读性：使用有意义的函数名和变量名。4.保证可适应性：5.保证移植性：6.保证模块化：2.2.C编码标准2.2.1.对C程序员的一些建议：l将C程序分成多个源代码模块，每个模块按功能划分；l按一致的逻辑方式组织所有的功能模块，相同的功能块放在同一个源文件中，如数据库访问、初始化、底层通信的实现等；l按易读的逻辑合理安排程序的流程；l使用头文件提高可维护性，保持类型说明的一致性；l不要在代码中直接使用数字常量和文件路径；l显示说明所有

3、使用到的函数及变量；l尽可能检查所有函数的返回值；l尽量减少全局变量和静态变量的使用；l不要依赖编译器和特殊机器特性；l不要等源代码写完后才开始加注释和写文档；l函数应尽量有返回值；l函数的调用应尽量判断返回值。2.2.2.文件文件的宽度尽量限制在80列以内，长度一般为10页(A4纸)，不要超过30页。头文件中避免重定义，使用如下宏:#ifndef__H#define__H…….#endif2.2.3.注释注释分二种：行内注释和注释箱。a)行内注释要简短。在意义不明确的变量后加

4、注释:----------专业最好文档，专业为你服务，急你所急，供你所需-------------文档下载最佳的地方----------专业最好文档，专业为你服务，急你所急，供你所需-------------文档下载最佳的地方示范1:shortmyVariable;/*DescriptionofmyVariable*/在超长(超过3/4页或者跨页)的函数和语句块的结尾处注释，注释应该在下一行，以提高可读性：示范2:voidMyFunction(){…………}/*End:MyFunction*/示范3:if(retur

5、nCode==SUCCESS){…………}/*End:if()*/注意：对特殊算法，非标准用法，及不可移植语句，要加以注释。a)较长的注释使用注释箱。示范4:文件头注释/*H************************************************File:?.cSubsystem:CommuncitionFunctionName:func1()……funcN()Description:Author:Date:Revision:**********************************

6、*****************/示范5:函数头注释/*F************************************************FunctionName:func1()Description:Input:Output:Globals:Return:Process:Note:Author:Date:Revision:***************************************************/示范6:代码块注释/*B*************************

7、************************BlockDescription*#a*#b----------专业最好文档，专业为你服务，急你所急，供你所需-------------文档下载最佳的地方----------专业最好文档，专业为你服务，急你所急，供你所需-------------文档下载最佳的地方…….***************************************************/1.1.1.命名l命名习惯示范1:指针voidfar*pExample;示范2:句柄HANDLE*h

8、Memory;示范3:指向指针的指针voidfar*(far*)ppMemory;示范4:函数名取名voidBuildMsgList(void),SortArray(void);命名应该尽量能表示该标识的意义，在形式方面尽量使用匈牙利表示法l常量定义对于“#define”,“typedef”,“struct”,“enum”语句，均用大写定义，要