7

我很难让 phpDocumentor 2 正常工作。

我有几个程序风格的文件,必须记录在案。我发现这样做的唯一方法是使用页面级 docblocks,但似乎它们在 phpDocumentor 版本 2 中不再正常工作。

stackoverflow 上的一个相关问题显示其他人在相同的问题中运行。在这个问题中,有两个建议:

  1. 将 a 添加namespace到应记录的文件中
  2. phpDoc 问题 910 开始,使用模板abstractnew-black

不幸的是,我无法找到工作。

  1. 当我添加命名空间时,命名空间本身会显示在文档中,但不会显示在文档块的内容中。
  2. 当我使用 phpDoc 2 的 phar 版本选择另一个模板(我尝试过zendabstract和)时,我得到了错误。显然这是一个已知问题new-blackPHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar

编辑:

我又进了一步。我安装了 PEAR 版本的 phpDocumentor,并尝试了每个可用的模板。但我还远未达到目标:生成文档中的页面级文档块。
模板分为两类:

  • clean, responsive,responsive-twigold-ocean: 它们不会在生成的文档中输出页面级文档块。
  • abstract,new-blackzend: 他们有一个文件部分的文档,显示预期的文件级文档。但是它们错过了几个资源(.js 文件和图像),因此它们看起来都一样,并且不能正常工作(导航窗格没有展开-折叠行为)。我查看了他们的 git 存储库,甚至那里的文件似乎也丢失了。

在这一点上,我只是想知道我是否正在寻找正确的方向:由于 phpDocumentor 2 中的主要回归和错误,不可能有一个显示文件级 docblocks 的文档的文档。

如果我真的走错了路,请建议我如何从我的 PHP 项目中获取有价值的文档。如果我走在正确的轨道上,请帮助我了解我缺少的难题中的重要部分。

4

0 回答 0