php - 在 PHP 文档块中包含 @param varname 是否仍然合适？

Question

根据维基百科@param，文档块参数type [$varname] description的格式$varname是可选的。这似乎得到了 phpDocumentor 项目的支持，该项目指出：

@param datatype $paramname description
@param datatype1|datatype2 $paramname description

注意：从 0.4.1 开始，@param 可以记录 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) { ... }

Answer 1

更“正确的形式”是包含 $paramname。它确保在将@param 行与函数签名中的匹配参数匹配时零歧义。它很可能仅作为“phpdoc.de 样式”的旧向后兼容性问题被列为“可选”。我怀疑这种可选处理在 phpDocumentor2 中是否仍然可用。