phpDocumentor文件夹-没有找到此文件的摘要

Question

我在我的项目中有一堆文件夹，我试图忽略它们。不幸的是，phpDocumentor似乎试图访问某些文件夹并获得“拒绝权限”错误。

Parsing C:\Users\Public\xampp\htdocs\select_user.php
PHP Warning:  file_get_contents(C:\Users\Public\xampp\htdocs\sql): failed to open stream: Permission denied in C:\Program Files\PHPStorm\PhpStorm 2017.2\plugins\phpdoc\phpDocumentor-2.9.0\vendor\phpdocumentor\reflection\src\phpDocumentor\Reflection\FileReflector.php on line 138
Parsing C:\Users\Public\xampp\htdocs\sql

Parsing C:\Users\Public\xampp\htdocs\table_plan.php
PHP Warning:  file_get_contents(C:\Users\Public\xampp\htdocs\tasks): failed to open stream: Permission denied in C:\Program Files\PHPStorm\PhpStorm 2017.2\plugins\phpdoc\phpDocumentor-2.9.0\vendor\phpdocumentor\reflection\src\phpDocumentor\Reflection\FileReflector.php on line 138
PHP Warning:  file_get_contents(C:\Users\Public\xampp\htdocs\vendor): failed to open stream: Permission denied in C:\Program Files\PHPStorm\PhpStorm 2017.2\plugins\phpdoc\phpDocumentor-2.9.0\vendor\phpdocumentor\reflection\src\phpDocumentor\Reflection\FileReflector.php on line 138
Parsing C:\Users\Public\xampp\htdocs\table_users.php
Parsing C:\Users\Public\xampp\htdocs\tasks

Warning: file_get_contents(C:\Users\Public\xampp\htdocs\tasks): failed to open stream: Permission denied in C:\Program Files\PHPStorm\PhpStorm 2017.2\plugins\phpdoc\phpDocumentor-2.9.0\vendor\phpdocumentor\reflection\src\phpDocumentor\Reflection\FileReflector.php on line 138
Parsing C:\Users\Public\xampp\htdocs\unlock_appraisal.php
Parsing C:\Users\Public\xampp\htdocs\util.php
Parsing C:\Users\Public\xampp\htdocs\vendor

我试图通过phpdoc.dist.xml排除这些目录。

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <parser>
        <target>docs/phpdoc</target>
    </parser>
    <transformer>
        <target>docs/phpdoc</target>
    </transformer>
    <files>
        <directory>*</directory>
        <file>*</file>
        <ignore>test/*</ignore>
        <ignore>assets/*</ignore>
        <ignore>doc/*</ignore>
        <ignore>docs/*</ignore>
        <ignore>examples/*</ignore>
        <ignore>html_sources/*</ignore>
        <ignore>logs/*</ignore>
        <ignore>vendor/*</ignore>
        <ignore>vendor/</ignore>
        <ignore>debug</ignore>
        <ignore>_do_this_for_troubleshooting/*</ignore>
        <ignore>*.pdf</ignore>
        <ignore>*.md</ignore>
        <ignore>*.json</ignore>
        <ignore>*.lock</ignore>
        <ignore>*.xml</ignore>
    </files>
</phpdoc>

忽略列表的工作方式是排除文件夹中的项是免税的，但是文件夹本身不例外。因此，phpDocumentor试图将文件夹作为文件读取，从而导致错误。这些在最终的HTML中也是可见的。

​

​

如何正确忽略文件夹？我知道我可以尝试使用--ignore sqlbuddy/,docs/，但是我确信这与在配置中使用ignore标记是一样的。另外，我更希望在一个中央文件中有一个忽略列表，而不是有两个单独的位置--一个在命令中，一个在配置XML中。

我再看一遍我的质询后，发觉这问题可能与此有关：

        <directory>*</directory>
        <file>*</file>

还有一个有趣的配置文档，我已经读过很多次了，但它似乎并没有解决我的具体问题。

Answer 1

忽略行为是“不要记录您在此文件夹中看到的内容”，而不是“根本不扫描该文件夹”。我认为这个文件夹的历史基础可能包含在您想要记录的类中引用的类。

我确信您可以“跳过”要忽略的文件夹，方法是将“目录”arg更改为要扫描的顶级目录的显式列表。