如何忽略phpDocumentor中的特定文件

Question

我正在用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忽略一些文件?

Answer 1

--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

Answer 2

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

在项目的根目录中创建一个phpdoc.xml配置文件，通过包含多个include/ignore选项来避免复杂的命令。可以很容易地把文件中所有必需的选项组合在一起，这些选项将被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配置文件