phpDocumentor 文件夹 - 未找到此文件的摘要

Question

我试图忽略项目中的一堆文件夹。不幸的是，phpDocumentor 似乎正在尝试访问某些文件夹并出现 "permission denied" 错误。

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 标签是一样的。此外，我宁愿将忽略列表放在一个中央文件中，也不愿有两个单独的位置 - 一个在命令中，一个在配置中 XML.

再次阅读我的问题后，我发现问题可能与此有关：

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

还有一个有趣的 config documentation 我已经读了很多遍，但它似乎没有解决我的具体问题。

Answer 1

忽略行为是 "don't document what you see in this folder"，而不是 "don't scan this folder at all"。我认为这样做的历史原因是该文件夹可能包含类中引用的类你 do 想要记录。

我相当确定您可以 "skip" 通过将 "directory" arg 更改为要扫描的顶级目录的明确列表来忽略您想要忽略的文件夹。

phpDocumentor 文件夹 - 未找到此文件的摘要

phpDocumentor folder - No summary was found for this file

php

xml

phpdoc

phpdocumentor2