php - 使用 Doxygen 时构建文档

Question

我开始使用 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)？我希望结构的每个元素都有相应的描述页面。

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

Answer 1

如果您运行的是 PHP 5.3，则 Doxygen 支持命名空间。如果您将它们放入，那么您的文档的结构将与 phpDocumentor 的包类似。查看以下链接以获取有关 PHP 命名空间的更多信息:

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

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