1.代码书写规范:
(1)代码不仅仅要足够高效,减少冗余,而且在合作过程中要易于合作人的阅读以便更高效的工作。而且命名要尽量避免二义性;
(2)在编写过程中,应养成写空白{ }的习惯,注意分行;
(3)下划线一般用于作用域和变量;
(4)使用Pascal和Camel形式去命名,区分函数和变量;
(5)注释应放在函数头,尽量只用ASCII字符;
2.代码设计规范:
(1)函数只做一件事;
(2)程序逻辑清晰易懂;
(3)用断言Assert判断程序应有的正确反应,if()、else if()来处理可能的错误,else用于错误测试通过后继续程序的运行;
(4)对于简单的数据类型,尽量不用类传递,应用指针传递;
(5)公共/保护/私有成员按照次序说明(不要混在一起说明);
(6)仅在必要时,才自定义操作符,才使用类型继承;
3.代码复审:
(1)软件工程中最基本的复审手段,就是同伴复审。对于至关重要的代码,我们要请不止一个人来做代码复审。
(2)复审要找出错误:编码错误、逻辑错误、算法错误、潜在错误和回归性错误。
复审还可以找到改进的地方,熟悉代码、学习知识
(3)代码复审步骤:
【1】通过编译;
【2】程序员测试过代码,可以加上outputDebugString监视程序控制流;
【3】程序员提供最新代码,和文件差异分析工具(Git目前应该可以做到);
【4】面对面复审时,复审者积极提出意见;
【5】让所有问题得到满意的答复;
【6】代码要考虑日后更新、维护留出余地;
【7】代码复审后:更正明显错误,记录暂时无法更正的错误;
(4)建立代码复审的核查表;
4.结对编程:
(1)结对编程注意角色分配、角色交换、记录预测和实际时间;
总结
实际上本文就是很好的书写规范。
时间: 2024-10-03 09:11:39