0. 常用

当你输入/** 时会出现如下界面

image.png

确定选择后会自动为你生成一些 JS doc

image.png

填充参数类型后，在引入界面，鼠标悬浮就可以看到如下提示

image.png

VS code自动推算返回值类型，可以通过`@returns` 对返回值做描述

再加上注释那将是完美！

/**
 * 这是一个用于演示的函数
 * @param {String} a 第一个参数
 * @param {String} b 第二个参数
 * @returns {String} 返回值
 */
export function JSDocTest(a, b) {
  return "";
}

image.png

只写注释

/**这是一个用于演示的函数 */
export function JSDocTest(a, b) {
  return "";
}

image.png

1 扩展

演示用法

@example后面的代码会被高亮处理

/**
 * @example
 * // returns "2"
 * JSDocTest("1","1");
 * @example
 * // returns "3"
 * JSDocTest("1", "2");
 *
 */
export function JSDocTest(a, b) {
  return a + b;
}

image.png

默认支持

export const Message = {
  name: "xiaodun",
  age: 18,
  isMan: true,
};

鼠标悬浮能得到类型提示，写代码的时候也能得到属性提示，按住Ctrl 悬浮还能看到原始值

image.png

2 语义化

@link 指定一个连接
@todo用于表示待开发的功能
@throws 表示会扔出错误
@readonly 表示只读
@deprecated 一个方法已经废弃
@constant 记录一个对象作为一个常量
@description 记录一个对象作为一个常量
@default 表示默认值
@version 表示版本
@override 一个标识符覆盖其父类同名的标识符
@global 指定一个在文档的标识是为全局性的标识
@function标记一个对象作为一个函数
@constructor 表示为一个构造器