代码规范和编码原则

(一)代码规范

1.代码风格规范,主要是文字上的规定;
2.代码设计规范,牵涉到程序设计、模块之间的关系、设计模式等方方面面的通用原则。

(二)代码风格规范

代码风格的原则是:简明、易读、无二义性。
1、缩进:将Tab键扩展定义为4个空格。不直接使用tab键的原因是它在不同的情况下会显示不同的长度。4个空格可读性高;
2、行宽:行宽必须限制,建议100字符;
3、括号:在复杂的条件表达式中,用括号清楚地表示逻辑优先级;
4、断行与空白的{}行:分行5、命名:匈牙利命名法6、下划线:分隔变量名字中的作用域标注和变量语义7、大小写(Pascal形式和Camel形式)8、注释

(三)代码设计规范

1、函数:只做一件事,做好一件事;
2、goto:可使用goto实现函数的单一出口(但也要尽量少使用),助于程序逻辑的清晰体现
3、错误处理:参数处理、断言。4、运算符:一般情况下不需要自定义操作符,运算符不要做标准语义以外的任何动作。运算符的实现必须非常有效率,如有复杂的操作,应定义一个单独的函数;

(四)代码复审

1、形式:自我复审、同伴复审、团队复审
2、目的:找出代码错误、发现逻辑错误、发现算法错误、发现潜在的错误和回归性错误、发现可能需要改进的地方、传授经验
3、代码复审后把记录整理出来:
(1)更正明显的错误
(2)记录无法很快更正的错误
(3)把所有的错误记在自己的一个“我常犯的错误”表中,作为以后自我复审的第一步

(五)结对编程

1、角色:
驾驶员:控制键盘输入
领航员:起到领航、提醒的作用
2、好处:(1)在开发层次,可以提供更好的设计质量和代码质量,两人合作解决问题的能力更强。
(2)对开发人员,带来更多的信心,高质量的产出带来更高的满足感。
(3)企业管理层次上,有效地交流,相互学习和传递经验,分享知识,取得更高的投入产出比。

posted @ 2022-11-06 11:11  wysl  阅读(282)  评论(0编辑  收藏  举报