4

我正在用 phpDocumentor 记录我在 PHP 中构建的程序。一切正常，但文档显示我有近 100 个错误，因为它正在读取我用来将文件上传到服务器的文件，但我没有创建。是否可以忽略给我所有错误的特定文件？这是我正在执行以生成文档文件的命令：

phpdoc run -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation

我试图忽略的文件位于/myprogram这样的目录中：

/modules/module1/uploader.php

我找到了一些关于使用的信息--ignore，但我不知道这是否指的是目录的特定内容。

是否可以在文件中写入index.php指示 phpDocumentor 忽略某些文件的内容？

4

2 回答 2

7

该--ignore标志将接受单个文件名（以及目录名或 glob 表达式）：

phpdoc run --ignore /var/www/html/myprogram/modules/module1/uploader.php -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation

或者因为它会接受部分目录，所以它可以缩短为：

phpdoc run --ignore modules/module1/uploader.php -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation
于 2012-12-28T20:38:01.707 回答
4

我希望，我的回答不会被否决。我在这里包括我的答案，以供将来参考和其他可能从中受益的人。

通过包含多个包含/忽略选项，在项目的根目录中创建phpdoc.xml配置文件有很大帮助，而不是使命令复杂化。可以轻松地将文件中的所有必需选项组合在一起，phpdoc以帮助构建文档。

例如，我的项目的phpdoc.xml配置文件如下，包含phpdoc选项：

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>App Plugins Documentations</title>
    <parser>
        <target>reference/docs</target>
    </parser>
    <transformer>
        <target>reference/docs</target>
    </transformer>
    <files>
        <directory>.</directory> <!-- Scan and parse all the php files except those found in the paths below -->
        <ignore>assets/*</ignore>
        <ignore>includes/gm-virtual-pages/*</ignore>
        <ignore>includes/app_virtual_pages/*</ignore>
        <ignore>includes/third-party/*</ignore>
        <ignore>includes/vendor/*</ignore>
        <ignore>reference/docs/*</ignore>
        <ignore>storage/*</ignore>
        <ignore>views/*</ignore>
        <ignore>index.php</ignore> <!-- Ignore all the index.php files -->
    </files>
</phpdoc>

这样您就可以包含/忽略多个路径和文件；甚至是您问题中的特定文件。您所要做的就是在ignore文件的相对路径中包含该选项。

<ignore>/modules/module1/uploader.php</ignore>

只需phpdoc在项目的根目录中运行带有phpdoc.xml配置文件的命令即可。

于 2017-05-16T10:56:16.817 回答