我有一位同事坚持认为他的代码不需要注释，这是“自我记录”。
我查看了他的代码，虽然它比我见过的其他人编写的代码更清晰，但我仍然不同意自文档代码与注释和文档代码一样完整和有用。
帮助我理解 他 的观点。
也许这只是我自己的局限性，但我不明白它怎么能是一个好的做法。
这并不是要争论 - 请不要提出为什么注释良好和记录良好的代码是高优先级的原因 - 有很多资源表明这一点，但它们对我的同行并没有说服力。我相信我需要更充分地理解他的观点才能说服他。如果必须，请提出一个新问题，但不要在这里争论。
另外，那些反对自我记录代码的人——这主要是为了帮助我理解自我记录代码传播者的观点（即积极方面）。
在我看来，任何代码都应该是自记录的。在良好的、自记录的代码中，您不必解释每一行，因为每个标识符（变量、方法、类）都有一个清晰的 语义 名称。有多余的评论实际上会使阅读代码变得更加困难（！），所以如果你的同事
在我看来，他的代码和文档很好。请注意，自我记录的代码并不 意味着 不应该有注释，而只是说不应该有不必要的注释。然而，问题是，通过阅读代码（包括注释和文档注释）应该可以立即理解代码的作用和原因。如果“自我记录”代码比注释代码需要更长的时间来理解，那么它并不是真正的自我记录。
