人月神话阅读笔记3

      就工具而言，即使是现在，很多软件项目仍然像一家五金店。每个骨干人员都仔细地保管自己工作生涯中搜集的一套工具集，这些工具成为个人技能的直观证明。正是如此，每个编程人员也保留着编辑器、排序、内存信息转储、磁盘实用程序等工具。

　　软件的文档是与机器同样重要的，即使是对于极其私人的程序，说明文档也是必须的。不应该由于进度压力等任何原因忽视文档的编写。绝大多数的文档失于概述部 分过于简略。程序的概述应包括目的、运行环境、输入输出的范围、函数和应用的算法、输入输出格式、操作指令、选项、运行时间、准确性。修改一段程序也需要 有一段概述，应包括流程图或者子程序结构图、详细的算法描述、所有文件的说明、通过结构的概述以及对最初设计进行更改的原因的说明。传统的用流程图说明程序的方式基本已经过时，因为如果流程图超过一页，将变得极其难懂。在源代码中嵌入说明的自说明文档方式是很好的改进。使用自说明文档的方式应注意以下几点：使用程序名和变量名携带更多的文档信息；使用空间和格式来显示子程序、嵌套，增强可读性；插入必要的段落说明，尤其是在模块的开头；另外在多说明使用 的原因，而不是仅仅是怎样使用，因为动机是理解的关键。

转载于:https://www.cnblogs.com/qinxian0/p/5443750.html