使用webpack 搭建React 项目番外篇- 生成接口文档

概述

有很多工具都能生成接口文档，本篇只讲jsdoc

添加引用

# 生成js文档

npm install --save-dev jsdoc

添加文件

1.webpack配置文件

webpack.config.js文件scripts，添加jsdoc命令

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "webpack-dev-server",
    "build": "webpack",
    "jsdoc": "jsdoc app -r -d docs",
    "jsdoc2": "jsdoc app/business/payUtil.js -r -d docs"
}

添加插件

vscode 添加插件 Document This

添加注释的方案

在类或者方法的上面，输入2次快捷键Ctrl+Alt+D ，插件会自动生成注释

样例如下

/**
 * PayUtil
 *
 * @export
 * @class PayUtil
 */
class PayUtil {
    /**
     * Need to show countdown
     *
     * @static
     * @returns {Boolean}
     * @memberof PayUtil
     */
    static needShowCountDown() {
        return true
    }
}

export default PayUtil

生成文档的命令

npm run jsdoc

比如上面的命令是将app目录下的js文件，生成文档到docs目录下。可以自行修改输入

生成文档如下：

原文地址：https://www.cnblogs.com/maochenhua/p/12058913.html