保持文档简练蛋具有描述功能
1、在每个函数的开始处放上序言，包括：
（1）身份证明（程序设计员的名称、日期和版本号）。
（2）所有函数和算法目的的说明。
（3）函数所做的修改以及所使用的数据。
（4）对程序外部文档的引用。
2、当定义每个变量、常量或类时，解释清楚它是什么及如何使用。如果从名称上就能明显看出这些信息则更好。
3、对程序的每个重要的片段（段落或函数），用一句注释简要的说明它的目的或动作。
4、如果每个重要片段的结束不明显，则加以指示。
5、避免机械模仿代码功能的注释，如：
counter++；//讲counter加一。
或者使用无意义的话。
6、对任何使用了技巧或意义不清楚的话语加以解释，如果能避免使用这样的语句则更好。
7、代码本身应解释程序是如何工作的。文档应解释它为什么工作及它做什么。
8、无论何时修改一个程序，确信文档得到了相应的修改。
