关于注释

关于注释 :

编码讨生活四年了，对别人的注释依然不那么信任。

对自己写注释的要求如下：

1. 代码尽量自说明 -- 变量名、方法命名尽量一眼就能读出他要干什么。

2. 尽量运用单一职责原则，不在一个方法里面实现复杂功能。副作用就是代码结构可能很复杂。

3. 尽量写功能说明性注释 -- 换句话说就是注释说明的是一段代码要干嘛的，而不是说明它是怎么干的。

对于某些项目要求要写修改人、修改的起止位置、修改时间等要求我原则上不认同，但会遵守。

软件注释望小里说可能无关紧要 -- 它不会影响程序的运行；
望大里说可能关系到项目的生死-- 好的注释可能大大提高开发测试效率、坏的注释起的是反作用甚至会误导程序员的思路。

注释绝对是软件开发人员、项目管理人员要花大精力在上面的 -- 它关系到程序的维护与二次开发的难易程度。