个人管理 - 什么是好代码

  公司今年的技术年会设置了一个最佳代码奖,主要是从提交的代码中评选出最好的,但到底好代码的评价有哪些维度呢?工作也多年了,代码也写过很多了,自己的代码也就一般吧,以前还真没有太多想“什么是好代码”这个问题。本篇把我知道的先罗列一些,也希望大家补充。代码好坏更多的是由写代码的人来控制,所以我也把它归为个人管理系列中。

  1. 代码规范,命名和排版遵守统一的规范
  2. 没有拼错的单词
  3. 在不同地方对类似意思的代码统一命名,如不会一个地方使用add,另一个地方使用insert
  4. 采用一致的简写规则,不会有的地方简写,有的地方又不简写
  5. 是否简单,不需要想什么就能明白代码含义
  6. 对性能有要求,写出来的代码是否满足性能要求
  7. 不需要镀金,是否客户需要的功能
  8. DRY: Don’t repeat yourself,没有重复代码
  9. 写短方法,这样易读、易重用、易测试
  10. 对类、方法和变量使用好的命名,最好直接从命名就能知道含义
  11. 单一职责,每个类只做自己的事
  12. 代码物理组织:目录、命名空间、包,把代码存储在一个容易找到的地方
  13. 代码逻辑组织:代码按逻辑访问,如层、服务
  14. 对复杂代码有对应的单元测试代码
  15. 好的代码可以通过不断重构而来
  16. 注释是有害的,尽量写可读代码。如果却是要写注释,需要在合适地方把注释写清楚
  17. 是否可以很好的适应改变

欢迎转载,转载请注明:转载自周金根 [ http://zhoujg.cnblogs.com/ ]

posted on 2010-01-07 22:09  周 金根  阅读(5495)  评论(42编辑  收藏  举报

导航