Coding style I'；我已经编程六年了，我在大学的作业因为编码风格而被扣分

过去6年我一直在编程。我最近刚开始攻读计算机科学的第一个学位。由于各种原因，我的工作似乎经常被减价，其中包括：

• 未注释代码
• 写入太长的标识符名称和方法
• 写太多的方法

在为许多初创公司做了六年的程序员，并吸收了包括编写“自解释代码”要求在内的最佳实践之后，我发现很难回到糟糕的实践中去

---

我能做什么？

自我记录的代码不是注释的同义词

关于这一点，我已经和许多高级开发人员争论过了。代码在传达意图方面可以走很长的路，但有些事情根本不能（也不应该）通过代码来记录

例如，如果您有一个高度优化的功能/方法或代码块，该功能/方法或代码块与底层问题域紧密耦合，并且需要非常具体的业务或解决方案知识。在这些场景中，需要注释

是的，是的，评论会带来相当多的问题，但这并不意味着它们没有帮助（或在某些情况下是强制性的）

我无法告诉你有多少次我读过同事的代码，并想到“到底是什么？！？”只是为了让他们解释说，他们需要这样做是因为我们瞄准的某个库或浏览器的某些怪癖等

注释是开发人员证明设计决策合理性的一种机制

至于你的其他问题，它们是主观的。多长时间太长？多少是太多？ 如果您在MS stack上，请向他们指出Microsoft的指导原则，否则无论您使用哪种语言，都会有无数的文章

---

希望这会有帮助。

按照教授对你的期望去做，这样你就可以通过这门课。好吧，接受他们的意见，不要忘记，如果你想要一个好的结果，就按照老师想要的方式去做。我的编码风格因老师而异。就像在现实生活中，你被分配到一个现有的项目。你必须遵循他们的风格。也许更适合？事实上，我正在使用Eclipse。你知道我在哪里可以找到java的最佳实践吗？@vondip Conventions查看第24节，它解释了你应该避免缩写等。@vondip也更正式：在此扩展：