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

【问题标题】：What is the correct way to document changes to an object/function in JSDoc?在 JSDoc 中记录对对象/函数的更改的正确方法是什么？
【发布时间】：2017-02-06 13:59:31
【问题描述】：

假设我有一个带有一个参数的函数：

/**
 * @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，但没有提到类似的东西，或者应该使用不同的标签。

【问题讨论】：

标签： jsdoc

【解决方案1】：

距离你的问题已经有一段时间了，但现在有这样一个同名标签：@since

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

【讨论】：

我知道 @since 标签，但我想知道是否有任何支持基本上使用它来创建一个更改日志，其中包含单个元素的多个 @since 条目。
啊，对不起。由于它只在标签后面的签名中提到“versionDescription”，我认为@since 不适用，因为它只表示“在特定版本中添加了类、方法或其他符号。”，而不是参数。