您如何解释您的团队成员评论他们编写的代码的重要性？我认识一些编写情节评论的程序员，而其他人则留下了很多不足之处，你在阅读评论时会有什么期待？
答案 0 :(得分：3)
有一些最低要求：
虽然注释应该保持最小，但是当显而易见时，没有必要对for循环定义进行注释， 我通常为我的程序员设定基本规则，当它定义明确时，他们坚持使用它
答案 1 :(得分：3)
最好的评论总是简洁，用几句话说。它应该说代码中不明显的东西。我看到很多人做出明显无用的评论，如：
if x==0 //if x equals 0 then...
即使代码只是你的代码，你也应该写评论，好像你要与另一个完全没有意识到它的程序员分享它。这样你就可以确保你永远理解它，并且从长远来看如果有人出现并选择那些代码，那么这个人就能理解它并扩展/使用它。
我认为评论可以提高可重用性。我希望像其他程序员一样，通过一个简单而简洁的评论来完全理解一段代码。
答案 2 :(得分：2)
在编写不直观的代码时写评论。没有理由对一个只迭代一个数组的方法进行评论，但是当你修复一个bug或者必须一起破解某个问题以解决问题时，最好有一个评论，这样你就可以在6个月之后快速理解该代码（和不要意外地撤消它）。
答案 3 :(得分：2)
评论代码是什么意思？ 实际代码或函数头？
如果您实际上是在谈论代码，那么这是一个失败的原因。您需要让他们编写可读代码并将其分解为有意义的块。评论错误的代码并不能使它成为一个好的代码，只会留下一个不一致的混乱。
至于标题文档，你必须让它们捕获重要的东西（例如，惊喜，指令）并妥协一些琐碎的事情（列出所有参数，重复签名的作用）。人们讨厌记录函数，因为大部分工作都花在编写琐碎的文本上，几乎侮辱了你的智慧（例如，在getHandleToFile（）上，“这得到了文件句柄”）。由于实际上重要的细节实际上并不像人们预期的那么重要，因此他们会感到惊喜，并且更有可能在这些特定情况下投入精力。
答案 4 :(得分：1)
我认为如果您正在编写其他人可能有一天必须遵循的代码，那么谨慎地留下关于正在做什么的好评。如果你只是为自己写一些东西，那么倾向于保持最小或根本没有。话虽这么说，我已经有了“不那么奢侈”，不得不回到我8年前写的代码并没有充分评论，用我不再使用的语言（类ASP）我可以告诉你，我希望我留下更多评论！
答案 5 :(得分：1)
我尝试评论我的大多数公共方法和类，在这些评论中，您可以阅读该方法的作用，参数的含义，以及输出的内容（如果适用）。
我有时也会在我的方法中添加评论，但是，我不会评论我在做什么，但为什么我这样做。
答案 6 :(得分：0)
如果您所写的语言不是人类可读的，我建议使用非常精细的方法和程序级别的评论。
如果您所编写的语言是人类可读的（C＃，VB等），我建议您在方法级别使用一些详细的注释，在程序级别使用最少的注释。
答案 7 :(得分：0)
答案 8 :(得分：0)
评论中最重要的事情是说实话。我一直在调查一个错误的次数只是为了找到一段“不太明显”的代码，还有一条评论说它应该与它正在做的相反。谁赢？你决定......
在相关的说明中，任何超过其记录部分的评论通常太长。