注释必须吗?

在javaeye上看到关于注释的争论。想谈下自己的看法:

1.软件工程的主题实际上除了最重要的数据，数据字典，源代码等。还有就是详细而规范的文档。包含开发过程文档(甚至包含各次项目关键性会议的记录)，维护和产品使用说明文档(通常给客户看)。

2.对于开发而言譬如写一个类时理想的状态是不需要任何注释和说明(当然可以加自己的名字和创建类的日期)。因为如果类目和方法名取得很OK的话。通常意义是不需要其他辅助的东西的。使用者只要一看到类名，方法名和默认参数名和定义。基本上就能知道如何使用了。但这往往是理想状态，很多时候业务复杂之后而且限于我们的英语的performance。能难实现，所以我们一般会整些类似javaDoc的东西，让接口调用者明白这个类，方法，参数是如何使用，还有就是实现的功能。

3.当我们写的代码需要后期维护时，除了开发文档(从宏观上把握整个项目，关键模块，重要的类和方法的实现思想和业务功能)，我们还需要对个别重要的，不是很能明白的类，方法等进行必要的注释。这样可以节省维护者大量的时间。

4.我不主张之前碰到过的一位朋友对所有类，方法都进行注释，甚至对很多行的做法。因为这样无疑会极大的影响开发效率。而且真的没这个必要，不然就是我们的取的类名和方法名实在是艰涩难懂(譬如用汉语拼音首字母来定义方法名)，否则大可不必!因为我们写的code，不是开源给n多人使用和share，我们更不是sun的接口规范制定者。源码离不开文档，javadoc，注释，良好的接口，方法的命名，参数的定义。但是不应该过度追求这些，尤其是比较detail的注释!别忘了，我们还有debug!(良好的程序员在修改别人代码前至少要debug下流程)

 

以上经验仅限于java，对于c等少数debug需要看堆栈信息的除外