IDO老徐,在深圳,某上市公司质量部负责人,干了十二年软件测试,公号"简尚" ,博客isTester.com ,关注「软件测试从业者综合能力提升」,微信957863300
代码审查(Code Review)最佳实践
上一篇 /
下一篇 2016-07-25 09:40:33
/ 个人分类:软件工程
|$Kkq0\
h-f0
如今敏捷开发盛行,代码审查非常重要;如下是转发文~51Testing软件测试网tsL,Cu)Ho_)G"\2O
代码审查可以帮助提高代码质量,避免由于代码习惯而造成的 bug。51Testing软件测试网Qj'MGe%}Z
下面列出的这些要点因该可以作为大部分代码审查的指导,如果是 Java 应用的话,这些建议应该被视作最佳实践。
m%b;v _!J7l)Gy051Testing软件测试网1_?;N~+^*`"g.LFy
"V~$?V5KU~8m0文档51Testing软件测试网@-t,F6C`{Q2b
J)e^^g3u8Iz
M.fKr0 1. Javadoc 应该在每一个类和方法中添加。51Testing软件测试网Sb Y0S.uK(J
2. 如果是修复某个 bug,应该添加 bug ID。51Testing软件测试网"E;Ai[~
c
Ti
3. 走捷径的方法或者复杂的逻辑要有解释。
A
d
~[f!}4o7?04. 如果代码会被公开,每个文件头都要标注版权信息。
Fj/N(xB:PhYk05. 复杂的 HTML,JavaScript,CSS 应该包含文档。51Testing软件测试网)g0X&{0i W/p&}
S c4h p)N k$wk0
f1O2J"n1F3hb dD.m$B01. 如果类似的逻辑被使用了多次,应该把它写成一个帮助类,然后在多出调用。
-a Y|bjfr {cX0[02. 鼓励使用 API 而不是重复编写代码解决相同的问题。51Testing软件测试网~3oaL+Oj/f|
3. 要强调代码的单元测试。51Testing软件测试网j8Mr8v)UcMz
4. 任何新加的代码不应该破坏已有的代码。
+R(^+Y'v]05. 假如是 Web 应用,JSP 不应该包含 Java 代码。