文档中是否有关于JSDoc标签的官方命令?

Is there an official order for JSDoc tags in documentation?

本文关键字：标签 官方 命令 JSDoc 是否 文档      更新时间：2023-09-26

我正在记录一个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标签记录功能参数时，参数顺序必须与功能签名的顺序一致。
相关文章：