【问题标题】:documentation of function calls [closed]函数调用的文档[关闭]
【发布时间】:2010-09-22 15:10:36
【问题描述】:

如何在 php 中记录函数调用?我想要类似的东西:

= = = =

function_name1(参数列表)

功能说明

foo bar(像 cmets 一样从 php-doc 中提取)

来电:

function_name2(参数列表)

function_name3(参数列表)

被调用 功能4 函数5

=============

function_name2(参数列表)

功能说明

foo bar(像 cmets 一样从 php-doc 中提取)

来电:

function_name5(参数列表)

被调用

函数1

..

【问题讨论】:

标签: php documentation


【解决方案1】:

【讨论】:

    【解决方案2】:

    使用最广泛的documentation standard in the PHP world is PHPDoc。它是从 JavaDoc 派生的。大量的 IDE 支持PHPDoc,这意味着它们可以自动化文档,您可以从中获得代码完成和其他功能。

    有几种工具可以从 PHPDoc 代码注释自动生成文档。 PHPdocumentor 已经在别处提到是最突出的,但您也可以使用Doxygen,它允许更广泛的文档格式

    更新: phpDocumentor 已经过时,无法正常使用 PHP5.3 代码(尝试过闭包?)。 (目前)有两个值得关注的替代方案:DocBloxphpDox

    【讨论】:

    • 谢谢!- doxygen 非常有用,格式清晰(但是,它没有记录来自 PHP 包含文件中的函数的调用)。
    【解决方案3】:
    猜你喜欢
    • 1970-01-01
    • 2011-09-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多