jsdoc - 在 JSDoc 中记录对对象/函数的更改的正确方法是什么？

Question

假设我有一个接受一个参数的函数:

/**
 * @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 ，但没有提到任何类似的东西，也没有提到应该用于它的不同标签。

Answer 1

自从您提出问题以来已经有一段时间了，但现在有这样一个同名标签: @since

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