使用Doxygen时构建文档

时间:2011-01-14 16:04:56

标签: php documentation doxygen

我开始使用Doxygen记录我的PHP5框架。我正在尝试使用CodeIgniter框架的内联文档作为参考。但是,它的文档是使用phpDocumentor语法编写的。下面是CodeIgniter的Loader类描述的示例:

/**
 * Loader Class
 *
 * Loads views and files
 *
 * @package          CodeIgniter
 * @subpackage       Libraries
 * @author           ExpressionEngine Dev Team
 * @category         Loader
 * @link             http://codeigniter.com/user_guide/libraries/loader.html
 */
class CI_Loader {
...
}

如何使用Doxygen实现相同的结构(Package-> Subpackage-> Category-> Class)?我想为结构的每个元素都有一个相应的描述页面。

另一个问题是如何构建项目的文档?

1 个答案:

答案 0 :(得分:3)

如果您运行PHP 5.3,那么Doxygen支持名称空间。如果你把它们放进去,那么你的文档的结构将与phpDocumentor的软件包类似。有关PHP命名空间的更多信息,请查看以下链接:

http://php.net/manual/en/language.namespaces.php

http://www.sitepoint.com/php-53-namespaces-basics/