方法/班级评论是否应该仅一致或需要应用？

Question

为了保持一致性，即使它们是简单的Getters和Setters方法或非常小的包装器类，我也总是在所有方法和类上应用评论（以Javadoc的形式）。但是我也努力编写自我纪念品代码，这通常会使评论多余。即仅在需要的地方写评论（在此之前，请尝试重写代码，以便您根本不需要评论）。因此，这两种方法似乎相互矛盾。

因此，应该以一致的方式应用方法或类别的评论，还是只有在定义中不完全清楚的含义时才能写出这样的评论？

Answer 1

一个简单的试石测试是检查课程是否比代码更多的评论。如果Yest，则意味着您的代码太复杂，很难使用任何人。

因此，最好编写自我解释代码。另外，无需为像播放器和盖特斯这样的明显事物编写评论。

所以我会和 只有从定义中不完全清楚含义时，才会写出这样的评论。

Answer 2

我用来为每种方法创建代码，但是现在只有在备注添加比代码本身更多的信息时创建文档。

这里有一个 问题 在一个带有很多答案的类似主题上。随着代码的发展，文档的更新被“忘记”。在链接中提到问题不好的文档中的问题比根本没有文档更糟糕。