我们可以为正在开发的项目制作许多种文档,这些文档包括但是不局限于下面这些:
■设计文档
■技术文档/开发指南
■数据词典(包含类文档)
■用户指南(尽管大多数Web应用程序是自我解释的)
在这里,我们并不是要讲解如何写技术文档,而是建议自动化这些过程,从而减轻开发工作的负担。
在一些语言中,有一些自动生成这些文档的方法——特别是技术文档和数据词典。例如,javadoc可以生成HTML格式的树型结构文件目录,该树型结构就包含了Java程序中类成员的原型及其描述。
对于PHP,也有一些可以提供该功能的工具。其中包括如下这些:
■phpdoc,可以从如下站点获取:http://www.phpdoc.de/。
它是PEAR用来对代码执行文档化处理的系统。请注意,术语phpDoc用于描述几个这种类型的项目,这就是其中之一。
■PHPDocumentor,可以从如下站点获取:http://phpdocu.sourceforge.net。
PHPDocumentor可以提供非常类似于javadoc的输出,而且稳定性非常好。看上去,PHPDocumentor的开发团队比我们这里介绍的其他两个开发团队更主动。
■phpautodoc,可以从如下站点获取:http://sourceforge.net/projects/phpautodoc/。
phpautodoc的输出结果也非常类似于javadoc的输出结果。
查找更多的这种类型(和常用的PHP组件)应用软件的一个好地方是SourceForge:http://sourceforge.net。
SourceForge主要用于UNIX/Linux社区,但是这里也有许多运行于其他平台的项目。