IDO老徐,在深圳,某上市公司质量部负责人,干了十二年软件测试,公号"简尚" ,博客isTester.com ,关注「软件测试从业者综合能力提升」,微信957863300
代码审查(Code Review)最佳实践
上一篇 /
下一篇 2016-07-25 09:40:33
/ 个人分类:软件工程
]9j
Q
{?0
如今敏捷开发盛行,代码审查非常重要;如下是转发文~
!O[K a(H7]l)[0
代码审查可以帮助提高代码质量,避免由于代码习惯而造成的 bug。
"[![$N#l
~&[|0下面列出的这些要点因该可以作为大部分代码审查的指导,如果是 Java 应用的话,这些建议应该被视作最佳实践。
f'GSP.QN_fZ}`J051Testing软件测试网j`/[~:M!p
^ rz#r.c
7[(F3|.ou+W-g0LnS n2L3NO0 1. Javadoc 应该在每一个类和方法中添加。
_/zXic!N02. 如果是修复某个 bug,应该添加 bug ID。
%pFL.q:k,uY03. 走捷径的方法或者复杂的逻辑要有解释。
\ty%o4Kk`6vK04. 如果代码会被公开,每个文件头都要标注版权信息。
7q8wg
JE^6vq05. 复杂的 HTML,JavaScript,CSS 应该包含文档。
3IDh7]5B ^4O0
h M K#i"J g%p&Q(^0
S
n }9w&V9A0功能51Testing软件测试网0\{JH&D(T(Qu/B
1. 如果类似的逻辑被使用了多次,应该把它写成一个帮助类,然后在多出调用。51Testing软件测试网&U/y\@(o
2. 鼓励使用 API 而不是重复编写代码解决相同的问题。
)|Wz%_ui2u03. 要强调代码的单元测试。51Testing软件测试网%Z*])A M U
s:u2Sr
4. 任何新加的代码不应该破坏已有的代码。51Testing软件测试网}'PG+dg;w EH}
5. 假如是 Web 应用,JSP 不应该包含 Java 代码。51Testing软件测试网 W7Ho+J+h^ ?:ys-Sao,dJ