高质量程序的标准

1,程序模块做过很好的设计,程序代码是这个设计的诠释;
2,设计的所有功能都有单独的,对应的测试程序;
3,这些测试都有简单的标准用于判断正确和错误;
4,程序模块的命名应与设计文档中的一致;
5,每个函数和变量都有明确的模块归属,全局函数和变量应有明显的标识且统一放置;
6,单个函数内只做简单的功能;
7,函数名能准确表示函数所做的事情;
8,函数调用关系清晰;
9,所有常数都用对应的,明确含义的宏定义或常量定义;
9,函数内部步骤清晰;
10,合理的函数返回值,不需要返回值的一律用void申明;
11,适当的注释;
12,对于接口函数,用doxygen风格的注释,以便于生成文档;
13,对于己知的,未解决的问题用专门的注释说明。
posted @ 2010-07-25 21:42  老猴的技术博客  阅读(833)  评论(0编辑  收藏  举报