在编码与编码之前评论和反对评论，然后评论

Question

在撰写代码时，有哪些论据支持和反对评论代码，而不是稍后回来编写所有评论？在编写代码之前写评论怎么样？

Answer 1

我认为在编码时写评论非常重要，但这不应该妨碍你以后再回过头来澄清事情。

编码时撰写评论

• 你可能不会再回去做。
• 你可能不记得你为什么做了你做过的事。
• 如果你不得不研究一种技术或算法，那么“引用你的来源”是一个好主意。

编码后撰写评论

• 您将从全新的视角看待代码，或许可以更深入地了解哪些部分不是很清晰。

Answer 2

而不是注释为变量，类，方法等编写具有非常描述性名称的代码

在大多数情况下，首选测试来记录代码的意图而不是注释。

评论一写完就立即立即创建“与代码同步”问题。

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

Answer 3

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

1. 忘记代码块的目的
2. 自我混淆

复杂的代码，例如循环和高级函数的algothyms 其他开发人员将无法理解代码 - 稍后在使用中包含您自己 还要占用内存，性能到想要改进时......可以做到

Answer 4

过程中。

你理解你的代码的每一行最好而你正在写它。