jsdoc基础-JZTXT

/**
 * 2、函数
 * @param {string} a - 参数1
 * @param {number} b - 参数2
 * @returns {boolean} - 返回值
 */
const sum = (a, b) => {
  return Boolean(a + b)
}

/**
 * 3、变量
 * @property {string} a - 属性1
 * @property {111 | 222} b - 属性2
 */
const obj = {
  a: 'xxx',
  b: 111
}

/**
 * 人物类型
 * @typedef {Object} Person
 * @property {string} name - 姓名
 * @property {number} age - 年龄
 * @property {string[]} friends - 朋友
 */
/**
 * 4、自定义类型
 * @param {Person} person - 人物
 */
const setPerson = (person) => {
  console.log(`姓名：${person.name}`)
  console.log(`年龄：${person.age}`)
  console.log(`朋友：${person.friends.join()}`)
}

/**
 * 5、类相关
 */

/**
 * 6、生成文档
 *     - jsdoc <文件/目录>
 */

/**
 * 7、自定义配置生成文档
 *     - -d或--destination：文档生成的目录
 *     - -c或--configure：指定配置文件路径
 *     - -t或--template：使用的模板
 *     - -u或--tutorials：指定教程文件路径
 *     - -p或--package：指定package.json文件路径
 *     - -R或--readme：指定README文件路径
 *     - -r或--recurse：是否递归处理子目录
 */

/**
 * 8、文档模板
 *     - taffydb
 *     - better-docs
 *     - clean-jsdoc-theme
 *     - daybrush-jsdoc-template
 *     - docdash
 */

/**
 * 9、jsdoc插件
 *     - 支持markdown语法
 */

/**
 * 10、利用eslint检查注释
 * 11、利用prettier规范注释
 */

/**
 * 12、实现类型检测
 *     - // @ts-check
 */

/**
 * 1、安装
 *     - 全局安装：npm i -g jsdoc
 *     - 项目安装：npm i -D jsdoc
 */
module.exports = {
  sum,
  obj,
  setPerson
}