Code Review之代码规范篇

　由于先前公司做了一个外国的项目,那个项目好像基于掌上电脑的一个小网站(具体的不敢问头太多),结果我们的HTML代码写的不好,
被国外的人说我们的代码结构不好,CSS里属性值老多重复等.在我看来可能当时这样一种网站由于时间进度\项目规模等各种原因,没有足够的人手去把那些东西写好.

  结果后来这个单子就丢了.
  头就急了,后来就让我负责全部开发团队的代码规范的Code Review事宜.他在向其他人宣布我的这一职责也明确说了.Code Reveiw中我主要检查代码规范,至于具体其他性能上,设计上的就不是我的范畴了
 
  但问题是:代码规范都是静态的东西.怎么执行?执行到什么程度好呢?你比如说:几乎所有的语言的代码缩进都要求4个空格,如果让团队每个人都做到这一点?把它们的各种开发工具编辑器的都设置一遍吗?让他们自己设置?如果他们重新安装的电脑了怎么办?
  看似代码缩进4个空格的这个简单问题,执行起来确有各种可能,这里绝对不能有教条思维,
 
  还比如javascript,变量没有申明前,就不要直接使用.但是你如果真的用了,也没有关系,程序也能跑.这一点怎么执行呢?我还要辛辛苦苦用jslint.com的工具来检查.
程序员出现这种问题,只是道德问题,而不是法律问题;而头非要反过来说是警察和小偷的问题,是法律问题.

争论归争论,做还得做；
 
  我初步的步骤如下；
  　1)调度svn命令,每天增量下载所有要Reivew项目代码的Source Code．
    2)Javascript:　　jslint.com
      HTML:   http://validator.w3.org/     
      CSS:    http://jigsaw.w3.org/css-validator/
      JSP:    PMD
      Java:   PMD/Checkstyle
      C#:     unknown
      aspx:   unknown
     
用这些工具检查下载下来的各种类型文件，然后形成一个Jira Issues,提交到SVN版本库里的相应的作者．

这个过程是蛮麻烦和蛮琐碎的．

　　1)整合这些工具,形成jira issue比较麻烦.
　　2) jira issues还要跟踪，重新下载被Review的svn代码,检查,然后要向发生问题的解释,然后让他执行,这个比较费时,工作量无法估量

最麻烦的是头还要我形成一个报告,列出哪些是团队经常犯的代码规范问题 ?哪些人经常犯?我说这些问题你直接去看jira,他说他不看那些detail的报告，他要那些总结性的．
我的哥，这些报告如果没有每一个平台去自动形成，那么就意味着我要自己手工去归纳，我归纳出来的这样的报告有意义吗？这样的报告只是静态的．这样的工作持续会持续多长时间？
　 我倒是想写一个软件平台，把上面的代码检查工具整合一下，自动形成jira issue，然后自动得出报告，但是这要费大量时间，而我又有其他工作．

各位，你们是如果做代码规范的Code Review的?

  
 
 
 
 

评论

1 楼 wuming305 2010-09-20  

这个 我倒建议你看看 Topo研发管理系统 如何结合 SVN做 在线的Code Review。
最后可以实现 跟踪，分析报告，工作量统计等等，完全可以解决你的当务之急啊。