Hai guys，
我见过人们在他们的节目中加入评论..
是否可以改善程序员间的通信 和代码可读性，通过明确指定程序员' 意图和假设？
评论应该是技术术语而不是自然语言吗？
如何使用评论尽可能有效？
在程序中添加评论真的是一个好习惯吗？
答案 0 :(得分：7)
注释只应用于解释为什么代码是这样的。它永远不应该解释代码正在做什么。代码描述了代码的作用。
话虽这么说，有些语言的工具会在注释中查找特殊字符以生成文档。 Java就是这样一种语言。但这些并不是代码注释，因为它们恰好使用与语言注释相同的语法。
答案 1 :(得分：2)
注释可用于自动记录，与其他开发人员之间的通信，内存，待办事项列表或功能的基本说明。请注意，评论应该是补充性的 - 如果您的代码需要评论，则需要重新考虑您的代码。
为了尽可能有效，请制定一个模板，让您的评论存在。再次，这不仅可以帮助您阅读和理解您的代码，还可以帮助解析器根据您的评论为您创建文档整个代码中的格式一致。
答案 2 :(得分：2)
编写清晰的代码始终是使代码易于理解的第一步。然后，您可以通过查看代码来解释不清楚的部分。
对于我自己，评论解释了我当时的想法。这样，从现在开始的六个月，当我不记得我写的是什么时，我可以用这些评论来理解。
评论的一些经典用法：
作为一项规则，如果您发现自己做了一些不明显的事情，请对其进行评论。
另一种评论方式是首先将函数体写为注释。然后将注释分开并将代码放在下面。当它最终起作用时，清理并修复注释。
侨！
答案 3 :(得分：1)
我尝试评论每个功能描述的高级别，但精确的方式，功能的作用。精度应该是这样的：没有必要读取函数的主体来理解函数的作用，或者重新实现它，并使它与任何调用它的代码完美地协同工作。
除此之外，我尝试保持功能足够小，以上基本上都是必要的文档。
有一段时间，代码中的内容可能会有些模糊或奇怪 - 我记录了这一点。
。应记录任何不明显或直观正确的事情，或者您花费一些时间思考的事情。想象一下你有记忆问题，忘了在一个月内写这个程序。然后想象你必须回去修理它。您想评论什么？这些评论如何对您最有用？
答案 4 :(得分：1)
最好让程序自我描述，然后不需要太多评论。
答案 5 :(得分：0)
首先尝试编写代码，以便人们可以在没有评论的情况下关注。