JavaScript 怎样写注释

函数、interface、enum、type、var的申明建议使用文档注释

1. 函数注释

/**
 * 获取店铺签约合同信息
 * @access http://api.xxx.com/getUserNameByTagIdFromServer
 * @param tagId 标签id {number}
 * @returns name 用户名称 {string}
 */
async function queryUserNameByTagId(tagId: string) {
  const userName = await getUserNameByTagIdFromServer(tagId);
  return userName;
}

2.interface

interface IUser {
  /**
   * 用户姓名
   */
  name: string;
  /**
   * 用户年龄
   */
  age: number;
}

const user = {} as IUser;

user.age = 3;
user.name = '赵云';

3. Enum

/**
 * 水果枚举定义
 * @param APPLE apple 苹果
 * @param ORANGE orange 橘子
 */
enum EFruit {
  /** 苹果 */
  APPLE = 'apple',
  /** 苹果 */
  ORANGE = 'orange',
}

4. 普通变量

/** 变量测试 */
const test2 = 0;

test2;