2012-08-27 63 views
0

@since用於顯示創建函數的版本。如果我稍後修改該功能,我應該更改@since值還是做其他事情以顯示有變化?@since的PHPDoc用法

回答

0

「@since」的基本用例確實只是表示首次引入該方法時的軟件包版本。

但是,由於這個標籤的內容實際上只是自由形式的文本,而且我不知道任何文檔軟件用於特殊創建任何類型的其他doc元素(例如,按照什麼版本引入它們的方法組報告),那麼我真的不用擔心在其他方面使用標籤。

例如,將原來的「@since 2.0 foo()介紹」更改爲「@since 2.7 foo($ arg)」,以顯示API已更改。我甚至可以使用多個標籤,以顯示該方法的API的歷史記錄:

* @since 2.0 foo() introduced 
* @since 2.7 foo($arg) added the $arg argument to the signature 
* @since 2.9 foo($arg = 'default') set a default for $arg