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

我正在记录一个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;

尽管有一个定义良好的顺序（按字母顺序），但我发现这有点令人困惑，因为它打乱了注释的自然顺序。这就是为什么我在寻找一种方法来写一个特定的正式订单标签

这些标签有官方订单吗

---

谢谢

JSDoc标签没有正式订单。我倾向于先放置更一般的标记，然后是更具体的标记，类似于您的第一个示例

一般来说，JSDoc并不关心标记顺序，但有几个显著的例外：

• 第一个标记之前的任何文本都将用作说明。您还可以使用

  @desc

  （或

  @description

  ）标记提供描述，就像您在示例中所做的那样
• 使用

  @param

  标记记录函数参数时，参数必须使用与函数签名相同的顺序

---

你好，杰夫·威廉姆斯。谢谢你的回答。我通常不使用描述标签。我确实像你说的，我只是在开头写描述，没有任何标签。至于参数顺序，我通常是按顺序写的，但我不知道这是一条规则。因此，感谢您提供的信息。：）