在过去的 6 年里，我一直在编程。我最近刚开始我的第一个计算机科学学位。由于不同的原因，我的工作似乎不断被降价，其中有很多：
- 未注释的代码
- 编写过长的标识符名称和方法
- 写了太多方法
在为众多初创公司担任了六年的程序员之后，并吸收了包括编写“自我解释代码”在内的最佳实践，我发现很难回到糟糕的实践中。
我能做些什么？
问问题
111 次
1 回答
4
自我记录的代码不是注释的同义词。
在这一点上，我与许多高级开发人员争论过。代码在传达意图方面可以走很长一段路，但有些事情根本不能（也不应该）通过代码记录下来。
例如，如果您有一个高度优化的函数/方法或代码块，它与底层问题域高度耦合，并且需要非常具体的业务或解决方案知识。在这些情况下需要注释。
是的，是的，评论伴随着相当多的问题，但这并不意味着它们没有帮助（或在某些情况下是强制性的）。
我无法告诉你有多少次我读了同事的一行代码并想“到底是什么？！？” 只是为了让他们解释说他们需要这样做是因为我们所针对的某些库或浏览器的一些怪癖等。
注释是开发人员证明设计决策合理性的一种机制。
至于您的其他问题，它们是主观的。多长时间才算过长？多少算太多？如果您在 MS 堆栈上，请将它们指向 Microsoft 的指南，否则无论您使用哪种语言，都会有无数文章......
希望有帮助。
于 2012-11-12T15:45:36.807 回答