PHPDoc的例子不帶行號

Question

根據phpDocumentor的文檔，展現一個例子將是這樣的：

@example [location] [<start-line> [<number-of-lines>] ] [<description>] 

這好像如果代碼永遠不會變化的有效解決方案，但只要你去添加新的代碼到哪裏該位置是，您的起始行可能會發生變化，這意味着您必須不斷更新這些不同的引用。

有沒有更好的方式來展示如何在DocBlock中使用類方法的例子，而無需引用外部當前使用的例子？

這裏是我的目標爲：

/** 
* @example This is how you use this method: 
* 
*  $baz = Foo::bar(array('bing' => $bing)); 
*/ 

然後它的文檔作爲例子出現。有任何想法嗎？

Answer 1

您可以通過「code」分隔符在docblock本身中顯示代碼示例。因此，對於您原來的例子：

/** 
* This is how you use this method: 
* <code> 
*  $baz = Foo::bar(array('bing' => $bing)); 
* </code> 
*/ 

的手冊頁[1]對於@example標籤顯示在文檔塊既是一個「代碼」部分以及@example指針在不同的文件行。

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.example.pkg.html