页面级docblocks和phpdocumentor模板

时间:2014-11-14 08:24:49

标签: php documentation-generation docblocks phpdocumentor2

我很难让phpDocumentor 2正常工作。

我有几个程序样式的文件,必须记录。我发现这是唯一使用page-level docblocks,但似乎它们在phpDocumentor版本2中无法正常工作。

A related question on stackoverflow表明其他人遇到了同样的问题。在这个问题中有两个建议:

  1. namespace添加到应记录的文件
  2. phpDoc issue 910开始,使用模板abstractnew-black
  3. 不幸的是,我无法找到工作。

    1. 当我添加命名空间时,命名空间本身会显示在文档中,而不会显示在docblock的内容中。
    2. 当我选择另一个模板(我尝试zendabstractnew-black)与phpDoc 2的phar版本时,我收到错误PHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar。显然这是一个known problem
    3. 编辑:

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

      • cleanresponsiveresponsive-twigold-ocean:他们不会在生成的文档中输出网页级文档块。
      • abstractnew-blackzend:他们有 doc by file 部分,其中显示了预期的文件级文档。但是他们错过了几个资源(.js文件和图像),因此它们看起来完全相同,并且无法正常工作(导航窗格没有展开 - 折叠行为)。我查看了他们的git存储库,文件似乎甚至都没有。

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

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

0 个答案:

没有答案