文档中是否有正式的JSDoc标签订单？

Question

我正在记录JavaScript API。我正在关注谷歌风格指南，但我没有发现标签的顺序。

我通常会记录一个这样的变量：

/**
 * @description Radius of the circle
 * @private
 * @memberOf Circle
 * @type {Number}
 * @default
 */
Circle.prototype._radius = 1;

正如您所看到的，我使用自己的订单编写标签，这是我认为最直观的标签。

以下是按字母顺序排列标签的相同文档：

/**
 * @default
 * @description Radius of the circle
 * @memberOf Circle
 * @private
 * @type {Number}
 */
Circle.prototype._radius = 1;

尽管有一个明确定义的顺序（按字母顺序），我发现这有点令人困惑，因为它会混淆评论的自然顺序。这就是为什么我正在寻找一种方法来编写具有特定官方订单的标签。

这些标签是否还有官方订单？

由于

Answer 1

JSDoc标签没有官方订单。我倾向于先放置更多的通用标签，然后是更具体的标签，类似于你的第一个例子。

一般来说，JSDoc并不关心标签顺序，但有一些值得注意的例外：

• 第一个标记之前的任何文本都将用作描述。您还可以使用@desc（或@description）标记提供说明，就像您在示例中所做的那样。
• 使用@param标记记录函数参数时，参数必须使用与函数签名相同的顺序。