注释中的PHP类功能列表

Question

每当我用PHP编写一个类时,我都喜欢在类的顶部放置一个公共函数列表,如下所示:

// add_project($apikey, $post, $email)
// create_user($apikey, $email, $firstname, $lastname, $rolename, $pid)     
// user_join_project($apikey, $email, $pid)

我想知道是否有任何工具可以自动化这个过程.也许我可以加载类文件,它可以生成函数名称,变量等列表？

谢谢!

Answer 1

试试phpDocumentor.您使用DocBlock语法进行注释(类似于Javadoc和其他语言),然后通过phpDocumentor解析器传递您的PHP源文件,并为您生成API文档.

一个粗略的例子:

/**
 * Adds a project.
 * 
 * @param string $apikey The API key.
 * @param object $post The post.
 * @param string $email A supplied email address.
 * @return void
 */
function add_project($apikey, $post, $email) {
    ...
}