[英]Automatically create documentation by reading function comments (PHP)
假設我有:
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());
我可以上課。
現在我的問題是:我可以將類函數中的注釋讀入字符串嗎? 因此,我可以創建自動生成的文檔。
您無法從PHP訪問注釋,因為目標文件包含在include,include_once,require或require_once中,因為php-parser會將所有注釋從代碼中刪除。
如果您需要執行此操作並且不想使用PHPDocumentor或Doxygen,但想要自己執行操作,則需要使用file_get_contents或任何其他讀取方法來讀取目標文件,並使用其他方法的常規表達式自己解析此代碼。您的選擇(例如,使用此庫-https: //github.com/nikic/PHP-Parser )。 並自己解析代碼,您可以從注釋中獲取所需的所有信息。
但這不是一件容易的事,所以我的建議是使用PHPDocumentor:P
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.