代码审核中的原则与问题

最近一直在审核代码,在看大家的代码的过程中发现一些问题,慢慢也总结出了一套

审核代码最最初级的原则:
  1. 新建的数据库字段或者表要有详细的注释说明
  2. 不能增加数据库服务器的负担,尽量减少查询次数和查询出的数据
    如果有重复查询或查询出过多数据的情况,不能通过
  3. 代码冗余,功能重复的情况不能通过
  4. 代码写的比较冗长,可以简化比较多的不能通过,例如可以用正则简化字符串的处理
  5. 有明显错误的代码不能通过
也发现一些代码提交的问题:
  1. 代码提交说明不能准确描述更改的代码
    例如: "修改页面提示"---你能从这个提示看出这次提交改动的是什么吗?如果改为"修改图片上传页面选择上传文件格式错误时的提示"呢?
  2. 代码提交说明没有附上工单地址
    每次提交代码都应附上这次提交所针对的工单地址,如果没有工单应在提交代码说明后面用括号注明"(无工单)",最好也附上无工单的原因
  3. 代码说明重复,很多次提交都是针对一个工单一个说明,实际上这是一个工单下面的多次更改,每次更改的代码都不一样,这样的情况代码提交说明应该是不同的,但是后面附的工单地址可以相同

你可能感兴趣的:(代码审核中的原则与问题)