JSDoc 安装教程

环境

• nodeJs v10.17.0
• jsdoc v3.6.3

操作说明

1. 全局安装jsdoc最新版
   npm install jsdoc -g
   全局安装jsdoc 指定v3.6.3版本
   npm install jsdoc@3.6.3 -g

2. 项目根目录下新建conf.json文件：

{
    "tags": {
        "allowUnknownTags": true
    },
    "recurseDepth": 10,
    "source": {
        "include": ["./encmap/"],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "templates": {
        "cleverLinks": true,
        "monospaceLinks": true,
        "default": {
            "outputSourceFiles": false
        },
        "applicationName": "demo",
        "openGraph": {},
        "meta": {},
        "recurse": true
    }
}

3. 生成命令

jsdoc -c conf.json -r

4. 默认情况下，JSDoc的默认模板为你的源文件生成适合打印的文档

5. 如需自定义模板，则需先安装（这里以docdash模板为例）

npm install docdash

6. 根据需要修改conf.json的配置，详细配置可参考docdash官网

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "include": ["encmap", "encmap/README.md"],
        "includePattern": "\\.js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": ["plugins/markdown"],
    "opts": {
        "template": "node_modules/docdash",
        "encoding": "utf8",
        "destination": "docs/",
        "recurse": true,
        "verbose": true
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": false
        }
    },
    "docdash": {
        "static": true,
        "sort": true,
        "search": true,
        "menu": {
            "Demo": {
                "href": "http://10.19.151.72:8080/ENCMAP_DEMO_FRONTEND/",
                "target": "_blank",
                "class": "menu-item",
                "id": "demo_link"
            }
        }
    }
}

7. （可选）在项目package.json里添加命令

"script": {
"generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}

8. 如配置了7则生成文档命令变成

npm run generate-docs