phpdoc 没有更新我的文档答案

【问题标题】：phpdoc does not update my documentationphpdoc 没有更新我的文档
【发布时间】：2017-01-29 22:35:51
【问题描述】：

phpDocumentor v1.4.4 Fedora 24

命令行：phpdoc -d ./docsrc -t ./output

我在 Fedora 24 上运行 phpDocumentor，并且有一次成功地为我的项目生成了文档。

我在函数中添加了一个 docblock，然后再次运行 phpdoc。但输出尚未更新。我验证了文件的时间戳，它们已重新生成，但未反映更改。

我随后做了很多更改，每次更改后都重新运行 phpdoc，但生成的文档没有更新。

我删除了所有的输出文件，重命名了输入文件的目录，总之我已经尽我所能说服 phpdoc 生成反映我的 php 文件更改的新文档，但无济于事。

似乎 phpdoc 正在某处缓存输出，但我找不到在哪里。我搜索了磁盘上包含 phpdoc 的每个路径，然后在每个路径中搜索“缓存”一词，但没有出现。

我尝试使用 --template 指令更改模板，但它无法识别该指令。

我曾尝试使用 --force 指令，但它无法识别该指令。

谁能启发我？

干杯，彼得

【问题讨论】：

您是否在浏览器中查看生成的 PHPDoc 文件？如果有，您是否清除了浏览器中的缓存？
是的，我已经清除了缓存，抱歉我忘记指定了。我也在 Firefox 和 Chrome 中查看过。当我切换浏览器时，文件不可能在缓存中，因为这是该浏览器的第一次，但它仍然显示旧的 php doc 文件。绝对确定浏览器缓存。

标签： php phpdoc

【解决方案1】：

这听起来像是我会从头开始完成整个过程的时候：

我是否正在修改./docsrc 目录树中的源代码？通过在vi/vim/nano/some-other-editor 中打开源成员进行验证，以确保源已更改。
我是否使用正确的语法修改了源代码？（请发布一些显示未更新文档的代码）
用一个简单的更改修改另一个文件中的文档，看看当我重新生成我的文档时是否会出现这个简单的更改。
我是否明确地--ignore-ing 我希望更改的文件或目录？（你好像不是）
我是否有带有<ignore> 指令的phpdoc.xml 或phpdoc.dist.xml 文件？ details
我是否拥有在./output 目录中创建/更新文件的必要权限？
执行phpdoc -d ./docsrc -t ./output 后，我是否看到使用vi/vim/nano/some-other-editor 时的预期变化？
我的浏览器是否缓存了以前版本的文档？（我知道你已经排除了这一点，彼得，我只是想让我的答案完整）

【讨论】：

感谢 Benny 冗长而周到的回复。目前，问题已经自行解决。不知道为什么。至于上面的问题，每个问题的答案都是正确的答案，所以要简明扼要。我决定为第二个问题/建议提供一些代码和结果。我创建了一个带有单个单行函数和一个 doc 块的小 php 文件。我生成了文档，修改了评论，重新生成了文档，然后就开始了！有效。然后我返回到我的源目录查看发生了什么，重新生成了所有文档并且它工作了。
我不知道为什么。为了避免为所有 WordPress 创建文档，我将自己的源代码复制到了 phpdoc 的单独目录中。我会不会太厚以至于忘记在更改后重新复制？我记得抄了好几遍。我想我永远不会知道。无论如何，感谢您提供的出色检查清单，这肯定会证明对未来很有用..

【解决方案2】：

这正是我创建PHPFUI/InstaDoc 的原因之一！大多数文档的问题在于它是静态的。虽然这对于不改变的库来说非常有用，但如果您想记录自己的代码，猜猜怎么着？它往往每天都在变化！使用 InstaDoc，您甚至可以在签入之前立即在本地计算机上查看文档。InstaDoc 在您请求页面时创建文档。它是目前最快的文档系统。大多数文档系统创建静态页面并吹嘘他们创建文档的速度。但猜猜怎么了？谁在乎？您想要的是立即查看当前代码库的文档。事实证明，扫描您正在使用的库的所有文件只需要几秒钟。 InstaDoc 会缓存该信息，因此您只需在第一次或添加新库时进行长时间扫描（然后只需几秒钟）。

一旦您扫描了一个库，文档就会立即出现，因为它使用 PHP 反射类来读取文件并显示文档。所以你刚刚修改的那个文件，它是完全 100% 记录在案的。不喜欢 cmets，更改它们，刷新页面。看到问题，更正它，刷新页面。注意到有什么可能会更好吗？刷新页面。想查看 PR 上的文档吗？很简单，只需删除缓存的索引并刷新页面即可。

InstaDoc 是开源的，而且还很年轻。如果不满足您的需求，请检查并提交 cmets 或 PR，但这是文档的未来。它还会为大容量站点生成静态文件，但最重要的功能是它可以让您即时反映刚刚编辑的代码，这就是它的魅力所在。

【讨论】：