jsdoc接口文档生成器

jsdoc

官方文档
https://jsdoc.app/

快速入门

需要安装node.js 及npm 环境

step.1 安装

1. 创建一个新文件夹myJsdoc

mkdir myJsdoc
cd myJsdoc

2.安装jsdoc

# 全局安装
npm install -g jsdoc
# 本地安装
npm install --save-dev jsdoc

step.2 创建测试入口js文件

在myJsdoc目录下创建demo.js文件，内容如下

/**
 * Viewer预览器
 *
 * @class Viewer
 */

class Viewer {
   

  constructor(name){
   
    this._name = name
  }

  /**
   * 获取名称
   *
   * @returns {string} - 返回字符串
   * @memberof Viewer
   */
  getName() {
   
    return 'abc'
  }

  /**
   * 设置名称
   * 
   * @param {*} name - 设置预览器的名称
   * @memberof Viewer
   */
  setName(name) {
   
    this