通过阅读功能注释（PHP）自动创建文档

Question

假设我有：

class myclass {

    /*
     * This function, bla bla bla
     */
    function myclass()
    {
        return(true);
    }

    /*
     * This function, bla bla bla
     */
    function myfunc1()
    {
        return(true);
    }

    /*
     * This function, bla bla bla
     */
    function myfunc2()
    {
        return(true);
    }
}

通过使用get_class_methods(new myclass()); 我可以上课。

现在我的问题是：我可以将类函数中的注释读入字符串吗？ 因此，我可以创建自动生成的文档。

Answer 1

您无法从PHP访问注释，因为目标文件包含在include，include_once，require或require_once中，因为php-parser会将所有注释从代码中删除。

如果您需要执行此操作并且不想使用PHPDocumentor或Doxygen，但想要自己执行操作，则需要使用file_get_contents或任何其他读取方法来读取目标文件，并使用其他方法的常规表达式自己解析此代码。您的选择（例如，使用此库-https: //github.com/nikic/PHP-Parser ）。 并自己解析代码，您可以从注释中获取所需的所有信息。

但这不是一件容易的事，所以我的建议是使用PHPDocumentor：P