11

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

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

这些标签甚至有官方订单吗？

谢谢

4

1 回答 1

11

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

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

  • 第一个标签之前的任何文本都将用作描述。您还可以使用@desc(or @description) 标签提供描述，就像您在示例中所做的那样。
  • 当您使用@param标签记录函数参数时，参数必须使用与函数签名相同的顺序。
于 2014-06-19T16:26:18.957 回答