带注释的结对编程

Question

多年来，我发现绿色程序员倾向于阅读注释而不是代码来调试问题。

从长远来看，让一个人记录另一个人的代码(反之亦然)并得到代码编写者的批准，会提高代码质量吗？

这是个好主意吗？

旁白:在预算方面，我正在寻找单人编程和结对编程之间的中间地带。

Answer 1

人们倾向于寻找问题的最简单的解决方案。如果有可用的“人类”描述，它很可能会在读者钻研深奥的代码之前被利用。当然，无论程序员是多么的新手，评论通常都会被优先考虑。

评论应该尽可能地保留下来。不幸的是，它们很容易变得陈旧(因为它们不能被编译器验证)。因此，它们应该保持在合理的最低限度，因为最终，代码本身是唯一可以信任的真正注释。

至于谁应该写评论，这取决于评论是在什么级别写的。例如，在更高的级别上，注释应该描述模块的外部行为，并且可以由更多的人编写。然而，在内部，注释应该解释不同代码块的意图。这样，读者就可以更容易地收集代码的习惯。这些注释应该由编码器编写。

Answer 2

我发现，当一个人写代码，另一个人写单元测试时，“结对编程”效果最好(并排工作，这样他们就可以看到对方在做什么)。你也可以偶尔交换一下角色。

Answer 3

如果原始作者没有记录代码，那么曲解算法的风险就会更高。在我看来，唯一比没有充分记录的代码更令人沮丧的是没有正确记录的代码。

您可能希望尝试此方法：

• 与未参与编程工作的开发人员一起执行代码审查。
• 在没有代码作者实际在场的情况下执行代码审查。只有审阅者，来自源代码控制的代码副本和编写的documentation.
• If审查者在没有外部帮助的情况下无法合理地理解代码，它没有充分的文档记录，应该返回给作者。
• 根据需要重复。