【问题标题】:Command to `phpdoc` an entire directory?命令`phpdoc`整个目录?
【发布时间】:2011-07-01 13:00:23
【问题描述】:

为整个项目生成 phpdoc 的命令行是什么?

目录结构

/Users/macuser/Sites/my-project/
    index.php
    config.php
    includes/
        class/
            test.class.php
        include-a.php
    docs-go-in-here/

我已经安装了 PEAR phpdoc 并且能够为单个 php 文件创建文档,但我不知道如何创建整个目录。

【问题讨论】:

    标签: php phpdoc


    【解决方案1】:

    phpdoc -h 是你的朋友:

      -d    --directory               name of a directory(s) to parse
                                      directory1,directory2
    

    【讨论】:

    • 谢谢-h 知道真的很有用。 -d 似乎成功了 :-)
    【解决方案2】:

    我建议考虑使用 doxygen 而不是 phpdoc,这是一个死项目。看看这个 - http://www.doxygen.nl/

    【讨论】:

    • 与 phpdoc 相比,doxygen 的显着优点/缺点是什么?请记住,我的源代码已经被 phpdoc 块大量注释。
    • engineeredweb.com/blog/10/9/… 的文章很好地解释了这些差异。
    • Doxygen 理解 PHPDoc 块语法,所以我从 PHPDoc 切换到它没有问题。我还发现非常有用的是搜索功能和作为生成文档的一部分的 UML 类继承图。还值得一提的是,它允许您在代码中拥有一个单独的页面,其中所有内容都标有@todo(这样您就可以得到一个很好的列表,列出要完成/重构的事情等)。
    • 这可能是一个很好的例子:icu-project.org/apiref/icu4c/classBasicTimeZone.html
    • 感谢您的 cmets,非常感谢他们。我喜欢你引用的示例输出,非常聪明!
    猜你喜欢
    • 2015-07-16
    • 1970-01-01
    • 1970-01-01
    • 2019-08-21
    • 1970-01-01
    • 2019-09-01
    • 2018-11-02
    • 1970-01-01
    • 2016-11-20
    相关资源
    最近更新 更多