页面级docblocks和phpdocumentor模板

Lor*_*yer 7 php documentation-generation docblocks phpdocumentor2

我真的很难让phpDocumentor 2工作.

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

stackoverflow上的一个相关问题表明其他人遇到了同样的问题.在这个问题中有两个建议:

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

不幸的是,我无法找到任何一个工作.

  1. 当我添加命名空间时,命名空间本身会显示在文档中,而不会显示在docblock的内容中.
  2. 当我选择另一个模板(我试过zend,abstractnew-black)与phpDoc 2的phar版本时,我得到错误PHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar.显然这是一个已知的问题.

编辑:

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

  • clean,responsive,responsive-twigold-ocean:他们这样做所产生的文档中未输出页面级的文档块.
  • abstract,new-blackzend:他们有一个doc by file部分,它显示了预期的文件级文档.但是他们错过了几个资源(.js文件和图像),因此它们看起来完全相同,并且无法正常工作(导航窗格没有展开 - 折叠行为).我查看了他们的git存储库,文件似乎甚至错过了.

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

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