通过读取函数注释(PHP)自动创建文档
假设我有:通过读取函数注释(PHP)自动创建文档,php,documentation,Php,Documentation,假设我有: class myclass { /* * This function, bla bla bla */ function myclass() { return(true); } /* * This function, bla bla bla */ function myfunc1() { return(true); } /* *
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_方法(new myclass())代码>我可以得到类
现在我的问题是:我能把类函数中的注释读入字符串吗?
因此,我可以创建自动生成的文档。如果目标文件包含在include、include\u once、require或require\u once中,则无法从PHP访问注释,因为PHP解析器会将所有注释从代码中删除
如果您需要这样做并且不想使用PHPDocumentor或Doxygen,但想自己这样做,则需要使用file_get_contents或任何其他读取方法读取目标文件,并使用您选择的其他方法的正则表达式(例如使用此库-)自己解析此代码。您可以自己解析代码,从注释中获得所需的所有信息
但这并不是一件容易的事情,所以我的建议是使用PHPDocumentor:p如果目标文件包含在include、include_once、require或require_once中,您就无法从PHP访问注释,因为PHP解析器会从代码中删除所有注释
如果您需要这样做并且不想使用PHPDocumentor或Doxygen,但想自己这样做,则需要使用file_get_contents或任何其他读取方法读取目标文件,并使用您选择的其他方法的正则表达式(例如使用此库-)自己解析此代码。您可以自己解析代码,从注释中获得所需的所有信息
但这并不是一件容易的事情,所以我的建议是使用PHPDocumentor:p如果目标文件包含在include、include_once、require或require_once中,您就无法从PHP访问注释,因为PHP解析器会从代码中删除所有注释
如果您需要这样做并且不想使用PHPDocumentor或Doxygen,但想自己这样做,则需要使用file_get_contents或任何其他读取方法读取目标文件,并使用您选择的其他方法的正则表达式(例如使用此库-)自己解析此代码。您可以自己解析代码,从注释中获得所需的所有信息
但这并不是一件容易的事情,所以我的建议是使用PHPDocumentor:p如果目标文件包含在include、include_once、require或require_once中,您就无法从PHP访问注释,因为PHP解析器会从代码中删除所有注释
如果您需要这样做并且不想使用PHPDocumentor或Doxygen,但想自己这样做,则需要使用file_get_contents或任何其他读取方法读取目标文件,并使用您选择的其他方法的正则表达式(例如使用此库-)自己解析此代码。您可以自己解析代码,从注释中获得所需的所有信息
但这并不是一件容易的事情,所以我的建议是使用PHPDocumentor:p像其他人一样使用;但是docblock应该放在方法定义之前,而不是放在方法定义内部谢谢@MarkBaker我知道PHPDocumentor,但我想自己做点什么:-)更新了示例,我仍然想知道如何得到这些注释:-如果你想重新发明轮子,具体使用getDocComment()
方法。。。。但是请注意,为了使用此方法检索注释,注释必须在类、函数或方法使用之前立即进行,就像其他人一样;但是docblock应该放在方法定义之前,而不是放在方法定义内部谢谢@MarkBaker我知道PHPDocumentor,但我想自己做点什么:-)更新了示例,我仍然想知道如何得到这些注释:-如果你想重新发明轮子,具体使用getDocComment()
方法。。。。但是请注意,为了使用此方法检索注释,注释必须在类、函数或方法使用之前立即进行,就像其他人一样;但是docblock应该放在方法定义之前,而不是放在方法定义内部谢谢@MarkBaker我知道PHPDocumentor,但我想自己做点什么:-)更新了示例,我仍然想知道如何得到这些注释:-如果你想重新发明轮子,具体使用getDocComment()
方法。。。。但是请注意,为了使用此方法检索注释,注释必须在类、函数或方法使用之前立即进行,就像其他人一样;但是docblock应该放在方法定义之前,而不是放在方法定义内部谢谢@MarkBaker我知道PHPDocumentor,但我想自己做点什么:-)更新了示例,我仍然想知道如何得到这些注释:-如果你想重新发明轮子,具体使用getDocComment()
方法。。。。但是请注意,为了使用此方法检索注释,注释必须立即位于类、函数或方法之前。我喜欢PHPDoc的文档编制标准:)+1Thanks@dmikam!是的,我知道我很固执,但我真的很想尝试一下-是的。我喜欢PHPDoc的文档编制标准:)+1Thanks@dmikam!是的,我知道我很固执,但我真的很想尝试一下-是的。我喜欢PHPDoc的文档编制标准:)+1Thanks@dmikam!是的,我知道我很固执,但我真的很想尝试一下-是的。我喜欢PHPDoc的文档编制标准:)+1Thanks@dmikam!是的,我知道我很固执,但我真的很想尝试一下-P