將@param varname包含在PHP docblock中是否仍然正確？

根據wikipedia 012blockdocblock參數的格式是type [$varname] description其中$varname是可選的。這似乎是由phpDocumentor的項目which states備份：將@param varname包含在PHP docblock中是否仍然正確？

@param datatype $paramname description 
@param datatype1|datatype2 $paramname description 
注：爲0.4.1，@參數可以記錄phpdoc.de風格，可選$ PARAMNAME

那麼，包含$ paramname還是應該將其忽略？

/** 
* Have a foo! 
* 
* @param string $foo is a string 
* @param string This is another string 
* @return string 
*/ 
function haveAFoo($foo, $bar) { ... }

來源

2012-06-05 Xeoncross

我會用實際的軟件（phpDocumenter）文檔通過wikipedias。 – dm03514

好吧，雖然沒有看到它們之間有任何衝突，但phpDocumentor基於docblock標準，所以wikipedia可能比phpDoc實現更重要。 – Xeoncross

它也可以幫助你的IDE –

更「合適的形式」將包括$ paramname。它確保將@參數行與其在函數簽名中的匹配參數進行匹配時不會造成歧義。這很可能只是與「phpdoc.de style」的舊向後兼容性問題列爲「可選」。我懷疑這個可選的處理在phpDocumentor2中仍然可用。

來源

2012-06-05 18:56:04 ashnazg

[看來你是對的]（http://www.phpdoc.org/docs/latest/for-users/tags/param.html）注意phpDocumentor支持@param標籤，它省略了名稱，這是不推薦的，但提供與現有項目的兼容性。「 – Xeoncross

將@param varname包含在PHP docblock中是否仍然正確？

回答

相關問題