注释格式: 以
/**开头, 以*/结束的注释
常用标签
-
@description: 添加代码功能描述, 如果在注释第一行写功能描述的话可以不需要使用该标签 -
@param: 声明参数类型、形参名、参数含义等 -
@returns: 声明返回值类型及含义 -
@example: 声明代码用例, 换行后跟markdown代码块语法```
示例
- 示例1
/** * 求两数之和 * @param {number} num1 数字1 * @param {number} num2 数字2 * @returns {number} * @example * ```ts * Sum(1, 2) // 3 * Sum(1, 99) // 100 * ``` */ function Sum(num1: number, num2: number): number { return num1 + num2 }
