安装PHPDocumentor
PHPDocumentor是为您的PHP程序和类创建API文档的快速便捷的方法。如果您熟悉Java的世界,它的工作方式与JavaDoc程序几乎相同,实际上,它是基于此程序的。
PHPDocumentor可以以多种不同的方式运行,但是我发现最简单的方法是再次使用PEAR安装所需的一切。要使用PEAR安装PHPDocumentor,请使用以下命令。
phpdocinstallphpdocumentor
要运行PHPDocumentor并查看命令列表,只需键入以下内容:
phpdoc-h
要运行PHPDocumentor,您需要提供几个选项,它们是:
t文档目录(即文档文件所在的位置)。
o输出格式(例如HTML,PDF等),定义为output:converter:template目录。
d目录(即源代码文件所在的目录)。
通过以上参数,使用以下语法来运行PHPDocumentor。
C:\projectDir>phpdoc-t"c:\projectDir"-oHTML:default:default-d"c:\projectDir\docs"
此处定义的输出格式是HTML,具有默认样式和格式。这是带有框架的文件,是程序使用的默认样式。要查看可用的格式类型,请转到位于以下位置的PHPDocumentor安装目录:
要在PHPDocs上获得其他样式,请对-o参数使用以下值。
HTML:default:l0l33t
要创建文档的PDF,请使用以下内容。
PDF:default:default
要获得类似于PHP主页的产品输出,请使用以下命令:
HTML:smarty:php
您可能会问如何获取PHP代码以生成此文档。尽管这并不复杂,但是还有很多事情要做,因此这将是另一篇博客文章的主题。