comments - 什么时候评论 "too much"，什么时候还不够？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

7年前关闭。




Improve this question




有一个正在进行的小辩论，我在那里讨论代码中注释的有效性。一位负责人指示他的开发人员不要使用注释，因为它们太“老式”了，另外几个开发人员表示他们从不使用注释，因为他们觉得他们所做的只是把代码弄得一团糟。

我一直非常坚持这样的做法，我用基本的注释块注释每个文件的顶部，注释每个方法/类/等定义，然后我注释代码中我认为我可能会在 6 中回来的任何地方月，心里想，“WTF”。

显然，这是主观的，但我很想知道是否有人对一种或另一种方式有任何真正好的论据或经验。

Answer 1

我会告诉你Jeff Atwood's wonderful post on the subject ，这正好击中了头部。