摘要: 保持文档简练蛋具有描述功能1、在每个函数的开始处放上序言,包括:  (1)身份证明(程序设计员的名称、日期和版本号)。  (2)所有函数和算法目的的说明。  (3)函数所做的修改以及所使用的数据。  (4)对程序外部文档的引用。2、当定义每个变量、常量或类时,解释清楚它是什么及如何使用。如果从名称上就能明显看出这些信息则更好。3、对程序的每个重要的片段(段落或函数),用一句注释简要的说明它的目的或... 阅读全文