JSDoc自动生成API文档

参考：https://www.shouce.ren/api/view/a/13232
https://blog.csdn.net/github_27546161/article/details/99626520
JSDoc是一个根据javascript文件中注释信息，生成JavaScript应用程序或库、模块的API文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。

下载JSDoc依赖

npm install  jsdoc  -g
npm install  jsdoc  -D

按照JSDoc规范编写JS业务文件

在src目录下编写 Animal.js、Dog.js 2个文件
Animal.js 代码为：

/**
* Animal类
*/
class Animal{

    /** 
    * @constructor
    * @param {string} name - 名字
    * @param {number} age - 年龄
    */
    constructor(name, age){
        this.name = name;
        this.age = age;
    }

    /** 
    * sayHello方法
    * @param {string} str - 名称
    */
    sayHello(str){
        console.log("hello " + str);
    }
}

Dog.js 代码为：

/** 
* Dog类 
* @extends {Animal}
*/
class Dog extends Animal{

    /** 
    * @constructor
    * @param {string} name - 名字
    * @param {number} age - 年龄
    * @param {string} color - 颜色
    */
    constructor(name, age, color){
        super(name, age);
        this.color = color;
    }

    /** 
    * 获取Dog的年龄
    * @return {number} 年龄
    */
    getAge(){
        return this.age;
    }
}

编写JSDoc配置文件 jsdoc-conf.json

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": ["./src"],
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_",
        "exclude": []
    },
    "plugins": [],
    "opts": {
      
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

生成主页

主页中可以添加对项目的描述、使用说明、注意事项等。在合适的目录下新建README.md文件，并在命令行选项中配置
README.md 代码：

# 使用jsDoc来生成文档
## Hello World示例
这里是JSDoc根页面

生成JSDoc文档

打开项目的package.json，在scripts中添加一行

"jsdoc": "node_modules/.bin/jsdoc -r -c src/jsdoc-conf.json -R README.md -d build/jsdoc"

执行创建命令，即可在build/jsdoc目录下生成API文档

npm run jsdoc