文档中是否有正式的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标记记录函数参数时,参数必须使用与函数签名相同的顺序.