【问题标题】:phpdoc codeigniter folder classes emptyphpdoc codeigniter 文件夹类为空
【发布时间】:2018-01-13 17:47:13
【问题描述】:

我想在我的 codeigniter 项目中使用 PHP Documentor。 我通过 pear 安装了 phpdocs,并尝试通过在我的应用程序目录中运行以下命令来使用它:

phpdoc -d controllers

所有方法都被注释为docblocks

我的结果是一个带有 index.html 文件的文件夹,但是当我在其中打开时,我无法输入我的任何课程。它返回一个错误:

找不到文件

更重要的是,我的课程目录是空的。出于好奇,我尝试在干净的 php 文件上使用 phpdoc,它显示了正常的文档。

有人可以指导我如何在 codeigniter 项目中使用 phpdoc 吗? 也许还有其他软件可以提供类似的结果?

【问题讨论】:

    标签: codeigniter documentation phpdoc phpdocumentor2


    【解决方案1】:

    如果类是由框架自动生成的,请查看文档块中是否包含@internal@ignore。如果是前者,则使用 --parseprivate arg。如果是后者,您必须手动删除该标签。

    我想不出没有任何其他文档生成的原因。

    【讨论】:

    • 我在我的项目中没有看到任何忽略或内部标签:/
    • 我的下一个想法是:a) 如果类在controllers 目录中不是,那么它们将不会被记录; b) 如果controllers 目录中的 的东西本身不是类,那么除了文件本身之外,phpDocumentor 没有任何东西可以实际记录。因此,对于 a),如果类定义文件位于其他目录中,则需要将该目录添加到您的 -d arg 中。对于 b),如果 controllers 中的文件只是过程代码,而不是类,则 phpDocumentor 没有“可记录的代码元素”可用于实际记录。
    猜你喜欢
    • 1970-01-01
    • 2010-11-16
    • 1970-01-01
    • 2011-08-10
    • 1970-01-01
    • 2013-01-28
    • 2017-08-07
    • 1970-01-01
    • 2018-08-26
    相关资源
    最近更新 更多