jsdoc利用模板生成js API文档

    xiaoxiao2021-03-25  134

    1.利用npm安装jsdoc模块 npm install jsdoc -g 2.由于jsdoc默认的生成文档模板不好看,所以需要下载一套好看些的模板,如 jaguar.js 下载地址:https://github.com/davidshimjs/jaguarjs-jsdoc 也可用npm下载 3.将node_modules/jsdoc/templates/default下面的内容删除掉,然后将第二步下载的全部内容放在里面 4.创建jsdoc的配置文件 建立一个conf.json {     "tags": {         "allowUnknownTags": true     },     "source": {         "include": ["lib"],         "includePattern": ".+\\.js(doc)?$",         "excludePattern": "(^|\\/|\\\\)_"     },         "templates": {                 "cleverLinks": true,                 "monospaceLinks": true,                 "default": {                         "outputSourceFiles" : true                 },                 "applicationName": "demo",                 "openGraph": {},                 "meta": {}         } } 保存在根目录下。 5.cmd下输入 jsdoc -c conf.json,生成的out文件夹就是文档生成的位置。 JSDoc中文文档:http://www.css88.com/doc/jsdoc/about-configuring-default-template.html
    转载请注明原文地址: https://ju.6miu.com/read-12408.html

    最新回复(0)