-4

支持和反对在编写代码时评论代码与稍后再写所有评论的论点是什么?在写代码之前写注释怎么样?

4

4 回答 4

1

我认为在编码时写评论是非常重要的,但这不应该阻止你稍后再去澄清事情。

编码时写评论

  • 你以后可能不会回去做。
  • 你可能不会记得你为什么做了你所做的事情。
  • 如果您必须研究一种技术或算法,那么“引用您的来源”是一个好主意。

编码后写评论

  • 您将从一个全新的角度看待代码,也许会更深入地了解哪些部分不是很清楚。
于 2012-08-27T19:12:21.680 回答
1

代替注释为变量、类、方法等编写具有非常描述性名称的代码。

在大多数情况下,更喜欢测试来记录代码的意图,而不是注释。

评论一写就立即产生“与代码同步”的问题。

我曾经评论过很多。现在,如果有的话,我会非常谨慎地使用评论。如果是这样,通常是针对不明确的异常边缘情况,或者由于相当模糊的原因不应该重构的代码,尽管看起来应该如此。

于 2014-05-30T12:24:18.803 回答
0

在删除之前说明显而易见的事情。

  1. 忘记代码块的目的
  2. 自我困惑

复杂的代码,例如循环和函数的高级算法 其他开发人员将无法理解代码 - 包括自己以后的使用 也占用内存,性能到想要改进时..可以做

于 2012-08-27T19:12:23.910 回答
0

中。

在编写代码时,您可以最好地理解代码的每一行。

于 2014-07-21T21:04:32.203 回答