微软的代码调试准则

微软的代码调试准则

陈能技
2007-10-10

今天在查阅MSDN帮助文档时偶然发现Visual Studio Team System对程序员的代码调试提出了一些指导原则，用户帮助程序员了解调试需要掌握的技巧和需要注意的行为规范。

其中指出：程序员应该避免假设测试会找到所有的bug。这个道理很多测试人员都明白，但是未必所有程序员都理解，因为在某些程序员眼中，找bug是测试人员的“专利”，程序员只是负责写程序就好了。

文中说道：“测试将永远无法找到所有bug。这是不可能的。代码很复杂。即使测试可以找到所有bug，您也不可能有时间修复所有这些bug。正确的做法是对您的产品进行设计，使得bug不会从一开始就存在于产品中。这样可以避免以后修复问题的麻烦。您必须对您代码的质量负责。测试小组只是验证您的质量。不要依赖测试人员来清除您的错误。”

另外，文章提出了几个改bug的建议：
1、程序员对所有bug修复做出注释。修复bug时，在代码中包括版本号、bug ID和姓名。这样其他人在以后查看该代码时，如果有关于修复的问题，可以与您联系以获取相关信息。

2、检查所有bug修复。至少让另外一个人来检查您的代码（peer review）。

3、在签入之前验证细微的bug修复。避免重复修复同一个bug。

4、通过将所有bug修复记录在测试发布文档（TRD）中并通过邮件发送给测试组，与测试组协同工作。

文中还提出两个不建议采取的行为：
在不通知他人的情况下修复他们的bug。研究并尝试修复他人的bug是很好的做法。您可以更好地了解代码，并且为他人提供支持工作。唯一不该做的是在不通知代码所有者的情况下签入代码修复。

在没有在同一环境中的相同版本中进行尝试的情况下，就将bug解释为“不可重现”。您必须回滚到发现bug的产品版本。不要进行这样的假设：如果bug没有在产品的当前版本上引发，则表示该bug一定已经修复。事实可能并非如此。代码可能已经改变，因此目前只是隐藏了bug。如果您持续研究某个bug，直到它引发，可能会发现问题的根本原因并修复该问题，使得该bug不会在任何计算机上再次发生。