在JSDoc中记录对对象/函数所做更改的正确方法是什么?

J.D*_*.D. 5 jsdoc

说我有一个带有一个参数的函数:

/**
 * @summary Some function.
 *
 * @since 1.0.0
 *
 * etc.
 */
function func( a ) {
   // do stuff...
}
Run Code Online (Sandbox Code Playgroud)

然后添加了几个版本,以后都支持第二个参数。在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...
}
Run Code Online (Sandbox Code Playgroud)

这样,人们很容易看到何时引入了这样的更改。JSDoc中是否有元素“更改日志”标准?

我已经在usejsdoc.org上检查了该页面的@since内容,但是没有提及类似的内容,也没有提及应使用的其他标签。

Bre*_*mir 0

自从你提问以来已经有一段时间了,但现在有这样一个同名的标签:@since

(FWIW,@version如果您想要特定方法的版本,则可以使用。)