先写注释

将注释作为设计过程的一部分使用

许多开发者把编写文档的工作推迟到开发过程的最后，即编码和单元测试完成之后。这是产生低质量文档的最可靠方法之一。写注释的最佳时间是在开发过程的开始，在你写代码的时候。先写注释使得文档成为设计过程的一部分。这不仅能产生更好的文档，还能产生更好的设计，并使编写文档的过程更加愉快。