不了解,就无法真正拥有。 ------------歌德
一、需要什么样的文档
a.使用程序:不同用户需要不同级别的文档
(1)目的
(2)环境
(3)范围
(4)实现功能和使用的算法
(5)“输入--输出”格式
(6)操作指令
(7)选项
(8)运行时间
(9)精度和校验
b.验证程序
c.修改程序
二、流程图
流程图显示了程序的流程判断结构,它仅仅是程序结构的一个方面。
三、自文档化的程序
把文档整合到源程序,保证编程用户能方便、及时地得到文档资料,这种程序被称为自文档化
宏可以利用命名和结构化声明,段落注释的广泛使用在任何语言中是一个很棒的实践。