Code Review之代码规范篇

WorldWelcome 2010-09-20 11:14:00
由于先前公司做了一个外国的项目,那个项目好像基于掌上电脑的一个小网站(具体的不敢问头太多),结果我们的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的?
...全文
187 点赞 收藏 3
写回复
3 条回复
切换为时间正序
当前发帖距今超过3年,不再开放新的回复
发表回复
mattlinsheep 2010-09-28
定期检查,不合格扣绩效
回复
KnowingAndDoing 2010-09-22
刚开始,把门槛定低点,但是必须要迈过去,过不去的无情淘汰。
然后再慢慢得提高门槛。
回复
loveisbug 2010-09-20
浩大工程,一点点来,建议参考《敏捷开发的艺术》相关章节,和《重构》。
回复
相关推荐
发帖
研发管理
创建于2007-08-27

1220

社区成员

软件工程/管理 管理版
申请成为版主
帖子事件
创建了帖子
2010-09-20 11:14
社区公告
暂无公告