文档介绍：北京北清视通信息技术有限公司
报告人:文明
2008年1月24日星期四
代码风格与注释规范
1
北京北清视通信息技术有限公司研发部
编程老手与高手的误区摘自《高质量C++/C编程指南》
自从计算机问世以来,程序设计就成了令人羡慕的职业,程序员在受人宠爱之后容易发展成为毛病特多却常能自我臭美的群体。
上流传的“真正”的程序员据说是这样的:
真正的程序员没有进度表,只有讨好领导的马屁精才有进度表,真正的程序员会让领导提心吊胆。
真正的程序员不写使用说明书,用户应当自己去猜想程序的功能。
真正的程序员的程序不会在第一次就正确运行,但是他们愿意守着机器进行若干个30小时的调试改错。
真正的程序员不接受团队开发的理念,除非他自己是头头。
真正的程序员几乎不写代码的注释,如果注释很难写,它理所当然也很难读。
真正的程序员不写文档也不需要文档,只有看不懂程序的笨蛋才用文档。
2
北京北清视通信息技术有限公司研发部
编程老手与编程高手摘自《高质量C++/C编程指南》
定义1:能长期稳定地编写出高质量程序的程序员称为编程老手。
定义2:能长期稳定地编写出高难度、高质量程序的程序员称为编程高手。
3
北京北清视通信息技术有限公司研发部
送给软件工程师的一句话
练好兵!
4
北京北清视通信息技术有限公司研发部
C++/C代码审查表摘自《高质量C++/C编程指南》附录A
文件结构
重要性
审查项
结论
头文件和定义文件的名称是否合理?
头文件和定义文件的目录结构是否合理?
版权和版本声明是否完整?
重要
头文件是否使用了 ifndef/define/endif 预处理块?
头文件中是否只存放“声明”而不存放“定义”
……
5
北京北清视通信息技术有限公司研发部
C++/C代码审查表摘自《高质量C++/C编程指南》附录A
程序的版式
重要性
审查项
结论
空行是否得体?
代码行内的空格是否得体?
长行拆分是否得体?
“{”和“}”是否各占一行并且对齐于同一列?
重要
一行代码是否只做一件事?如只定义一个变量,只写一条语句。
重要
If、for、while、do等语句自占一行,不论执行语句多少都要加“{}”。
重要
在定义变量(或参数)时,是否将修饰符* 和& 紧靠变量名?
注释是否清晰并且必要?
重要
注释是否有错误或者可能导致误解?
重要
类结构的public, protected, private顺序是否在所有的程序中保持一致?
……
6
北京北清视通信息技术有限公司研发部
C++/C代码审查表摘自《高质量C++/C编程指南》附录A
命名规则
重要性
审查项
结论
重要
命名规则是否与所采用的操作系统或开发工具的风格保持一致?
标识符是否直观且可以拼读?
标识符的长度应当符合“min-length && max-information”原则?
重要
程序中是否出现相同的局部变量和全部变量?
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则?
静态变量、全局变量、类的成员变量是否加前缀?
……
7
北京北清视通信息技术有限公司研发部
C++/C代码审查表摘自《高质量C++/C编程指南》附录A
表达式与基本语句
重要性
审查项
结论
重要
运算符比较多,是否用括号清楚地确定表达式的操作顺序?
是否编写太复杂或者多用途的复合表达式?
重要
是否将复合表达式与“真正的数学表达式”混淆?
重要
是否用隐含错误的方式写if语句? 例如
(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。
(2)将浮点变量用“==”或“!=”与任何数字比较。
(3)将指针变量用“==”或“!=”与NULL比较。
如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判断移到循环体的外面?
重要
Case语句的结尾是否忘了加break?
重要
是否忘记写switch的default分支?
重要
使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。
……
8
北京北清视通信息技术有限公司研发部
C++/C代码审查表摘自《高质量C++/C编程指南》附录A
常量
重要性
审查项
结论
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串?
在C++ 程序中,是否用const常量取代宏常量?
重要
如果某一常量与其它常量密切相关,是否在定义中包含了这种关系?
是否误解了类中的const数据成员?因为const数据成员只在某个对象生存期内是常量,而对于整个类而言却是可变的。
……
9
北京北清视通