jsDoc.JS 自动生成文档

3,937 阅读1分钟
  • npm 搜jsdoc
  • 先安装
  • 看文档介绍
  • 试试看

中文连接 www.html.cn/doc/jsdoc/i…

github  github.com/jsdoc/jsdoc

英文文档 jsdoc.app/

// jsdoc.conf.json 配置文件
{    "plugins": [],    "recurseDepth": 10,    "source": {        "include": ["./porxyModels/","./controller/"] // 需要生成文档的js    },    "sourceType": "module",    "tags": {        "allowUnknownTags": true,        "dictionaries": ["jsdoc", "closure"]    },    "templates": {        "cleverLinks": false,        "monospaceLinks": false    },    "opts": {        "template": "templates/default",         "encoding": "utf8",                      "destination": "./doc/jsdoc/",  // 输出目录        "recurse": "true"         }}

"scripts": {    "jsdoc": "jsdoc -c ./jsdoc.conf.json",  },

  • 输出后的是html文件


  • 打开后(现在使用的是默认模板)


  • over