Coding style 文档样式
从我的一门编程课程的教学大纲中可以看出：“如果您可以只阅读注释，而不看代码，并解释代码的作用，那么您的文档就足够了。”Coding style 文档样式,coding-style,comments,Coding Style,Comments,从我的一门编程课程的教学大纲中可以看出：“如果您可以只阅读注释，而不看代码，并解释代码的作用，那么您的文档就足够了。” 你们听说过这样的文档风格吗？这是一种好的做法吗？对我来说似乎过于热情了。我有，我自己的研究生工作最初有这样的要求。这可能有点过分热情，但如果它能让人们评论他们的代码，那么我完全支持它。我有，我自己的研究生工作最初有这样的要求。这可能有点过分热情，但如果它能让人们评论他们的代码，那么我完全支持它。我会说相反的话。一个好的文档是一个能说明问题的代码！有些注释倾向于降低代码的可读性和
你们听说过这样的文档风格吗？这是一种好的做法吗？对我来说似乎过于热情了。我有，我自己的研究生工作最初有这样的要求。这可能有点过分热情，但如果它能让人们评论他们的代码，那么我完全支持它。我有，我自己的研究生工作最初有这样的要求。这可能有点过分热情，但如果它能让人们评论他们的代码，那么我完全支持它。我会说相反的话。一个好的文档是一个能说明问题的代码！有些注释倾向于降低代码的可读性和趣味性。如果我们一直这样对初学者说，他们编写的程序的代码与注释的比率将非常低，这是一个巨大的风险（换句话说，这肯定意味着他们对代码的注释过多，这不是很好）。注释应仅在解释非平凡算法或指令时编写。其余的应该留给代码来完成（比如命名变量，比如你理解它们的工作）。我会说相反的话。一个好的文档是一个能说明问题的代码！有些注释倾向于降低代码的可读性和趣味性。如果我们一直这样对初学者说，他们编写的程序的代码与注释的比率将非常低，这是一个巨大的风险（换句话说，这肯定意味着他们对代码的注释过多，这不是很好）。注释应仅在解释非平凡算法或指令时编写。其余的应该留给代码来完成（比如在理解变量的工作时命名变量）。这是一个很好的实践。这意味着您可以将代码视为黑匣子，这通常会使生活更轻松。我同意这样记录是不好玩的，但是你可以考虑让同事帮你。甚至可能是像技术作家这样的专家。这是一种很好的做法。这意味着您可以将代码视为黑匣子，这通常会使生活更轻松。我同意这样记录是不好玩的，但是你可以考虑让同事帮你。甚至可能是像技术作家这样的专家。在课堂上，是的。那位教授想知道你在代码背后的意图。那个教授除了看你的代码之外，没有简单的方法来问这个问题。它还将帮助你将作业的一部分分割成可编程的小块
在现实世界里？视情况而定。我们将工作记录到提交时修改的任何类中——这是记录更改背后意图的好地方。大量的评论需要大量的维护。如果注释解释了实现的原因，并且该实现发生了变化，那么注释也会发生变化。在类的上下文中，是的。那位教授想知道你在代码背后的意图。那个教授除了看你的代码之外，没有简单的方法来问这个问题。它还将帮助你将作业的一部分分割成可编程的小块
在现实世界里？视情况而定。我们将工作记录到提交时修改的任何类中——这是记录更改背后意图的好地方。大量的评论需要大量的维护。如果注释解释了实现的原因，并且实现发生了变化，那么注释也会发生变化。代码应该很容易理解。这可以通过多种方式实现：
同时，过多的注释是另一个需要维护的项目，当代码发生更改时，注释与代码保持同步，并且注释是最不可能在更改时正确维护的项目。代码应该易于遵循。这可以通过多种方式实现：
同时，过多的注释是另一个需要维护的项目，当代码发生更改时，注释与代码保持同步，并且注释是最不可能在更改时正确维护的项目。说明含糊不清。你应该向你的导师寻求澄清 有些人可能会将该指令解释为您的注释描述了代码。这不是大学毕业后的好习惯。然而——这是根据经验——对于那些给初学者的作业评分的人来说，这可能是非常有帮助的。你想帮助那些给你的工作评分的人 另一种解释是