phpdoc不会更新我的文档

时间:2017-01-29 22:35:52

标签: php phpdoc

phpDocumentor v1.4.4 Fedora 24

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

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

我在一个函数中添加了一个docblock,并再次运行了phpdoc。但输出尚未更新。我验证了文件的时间戳,它们已经重新生成,但没有反映出这些变化。

我随后进行了大量更改,并在每次更改后重新启动phpdoc,但生成的文档不会更新。

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

似乎phpdoc正在某处缓存输出,但我找不到位置。我搜索了包含phpdoc的磁盘上的每个路径,然后在每个路径中搜索“cache”一词,但不会发生。

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

我已尝试使用--force指令,但它无法识别此指令。

有人可以启发我吗?

干杯, 彼得

2 个答案:

答案 0 :(得分:0)

这听起来像是我从一开始就完成整个过程的时间之一:

  • 我是否在./docsrc目录树中修改了源代码?通过在vi / vim / nano / some-other-editor中打开源成员进行验证,以确保源已更改。
  • 我是否使用正确的语法修改了源代码? (请发布一些显示未经更新的文档的代码)
  • 通过简单的更改修改另一个文件中的文档,并查看在重新生成文档时是否显示该简单更改。
  • 我明确地--ignore - 我希望改变的文件或目录吗? (你似乎不是)
  • 我的phpdoc.xmlphpdoc.dist.xml文件是否有<ignore>指令? details
  • 我是否具有在./output目录中创建/更新文件的必要权限?
  • 我执行phpdoc -d ./docsrc -t ./output后,在使用vi / vim / nano /某些其他编辑器时,我看到了预期的变化吗?
  • 我的浏览器是否缓存了以前版本的文档? (我知道你已经把彼得排除在外了,我只是想让我的答案完整)

答案 1 :(得分:0)

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

一旦您扫描了库,该文档就会立即显示出来,因为它使用PHP反射类读取文件并显示文档。这样,您刚刚修改的文件就完全被100%记录了。不喜欢这些评论,对其进行更改,然后刷新页面。看到一个问题,纠正它,刷新页面。注意到有什么更好的办法了吗?刷新页面。是否想查看PR上的文档?很简单,只需删除缓存的索引并刷新页面即可。

InstaDoc是开源的,还很年轻。检查出来并提交评论或PR(如果它不满足您的需求),但这是文档的未来。它还会为大量站点生成静态文件,但是最重要的功能是,它使您可以立即反映出刚刚编辑的代码,这使它变得很棒。