这是一份来自 Google Code 的 JSDoc 标签参考。

@author 编写代码的作者

@deprecated 用 @deprecated 注解标记废弃的方法、类或接口。废弃注释必须包含简单、清晰的指示,以便人们修复他们的调用站点。

@desc 提供描述文本,等同于无标记的首行

@fileOverview 提供文件的概览

@param 函数的参数值

@returns 函数的返回值

@see 相关的资源,引用链接

/**
 * 这是一段无标记的首行描述文本
 * @fileoverview Description of file, its uses and information
 * about its dependencies.
 * @author username@google.com (First Last)
 * @desc 这是一段描述文本
 * @param {number} num A number to add.
 * @param {string} str A string to add.
 * @return {boolean} Whether something occurred.
 * @see https://github.com/google/styleguide
 */

const func = (num, str) => {
  return false;
}

Enum 枚举类型,在定义了枚举之后,不可以向枚举添加额外的属性。枚举必须是常数,而且所有枚举值也是不变的。

/**
 * An enum with two options.
 * @enum {number}
 */
const Option = {
  FIRST_OPTION: 1,
  SECOND_OPTION: 2,
};

参考链接