“完成”宣言(转)

作者 译者 发布于 2010年3月20日 上午12时2分

社区

主题

,

标签

贴出一篇“完成宣言”以引发讨论，其中谈到团队成员针对各自的工作质量向彼此做出的承诺，并清晰表明了他们对于使用代码交付业务价值的承诺。

他的“完成”条件列表包括：

• 我会确保我的代码可用。我的代码是为了供他人使用、与他人交互的，我所写的一切都要保证这是令人愉快的过程，而且应该降低工作量，而不是增加。
• 我会确保我的代码风格服从团队一致同意的风格。未来会是别人，而不是我，来维护和修补我的代码。所以虽然我可以灵活设计并利用任何技术来构建我的解决方案，我还是会遵循标准，以便于其他人将来维护我的代码。
• 我同意将我的方法保持在合理的大小。大方法难以查看与调试。我会尽量把我的方法保持在合理的大小，以降低复杂度。
• 我会注释所有的代码。不管是创建新代码还是变更现有代码，我都会写下简明扼要的注释，说明我做了什么。这样其他人在阅读代码时，就能理解我做了什么以及代码试图实现的目的。
• 我同意对我的代码做单元测试。我同意让这些测试可以重用、足够健壮。我会确保测试说明它测试的对象及其原因。这样其他人在重构或修复 bug时，不仅可以运行我的测试，还能了解我的代码试图达到的效果。
• 我同意维护现有代码的单元测试。当我改变或添加现有代码的新功能时，我会确保所有的测试都可以通过，而且新功能也有对应测试。
• 我同意努力让我的代码的测试覆盖率达到80％。检查完代码覆盖率，我就可以确保所写的一切代码都有价值，不存在会在未来产生问题的“惊奇代码”。我会努力让覆盖率更高。
• 我同意正确检查代码的集成状况。当我写完我的代码后，我会和其他开发人员一起检查我的代码，确保与他人的代码可以一起正确工作，交付客户请求的功能。