假设我有一个带有一个参数的函数:
/**
* @summary Some function.
*
* @since 1.0.0
*
* etc.
*/
function func( a ) {
// do stuff...
}
然后添加了几个版本以后支持第二个参数。在PHPDoc中,您可以添加其他@since
条目以保留特定于该元素的更改日志:
/**
* @summary Some function.
*
* @since 1.0.0
* @since 1.2.0 Parameter b was added, because reasons.
*
* etc.
*/
function func( a, b ) {
// do stuff...
}
通过这种方式,人们很容易看到何时引入这样的变化。 JSDoc中是否有元素“更改日志”标准?
我已经检查了page for @since
on usejsdoc.org,但是没有提到这样的内容,或者应该使用不同的标签。