【插件】jsdoc的使用

前言

转载:https://blog.csdn.net/github_27546161/article/details/99626520

中文文档:https://www.html.cn/doc/jsdoc/about-namepaths.html

步骤

  1. 安装jsdoc
    # 全局
    cnpm install -g jsdoc
    
  2. 项目根目录添加jsodc的配置文件(ps:看文档有多种方式,我选择了这一种,因为简单)
    json中主要的是source.include。替换为自己项目中需要生成文档的js文件的目录即可
    {
      "tags": {
        "allowUnknownTags": true
      },
      "source": {
        "include": ["./static/js"],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
      },
      "templates": {
        "cleverLinks": true,
        "monospaceLinks": true,
        "default": {
          "outputSourceFiles": true
        },
        "applicationName": "demo",
        "openGraph": {},
        "meta": {}
      },
      "plugins": ["plugins/markdown"]
    }
    
  3. 执行命令开始生成
     jsdoc -c conf.json
    
    这时候会在项目根目录生成文件夹,里面有相关的js api文档文件。
    在这里插入图片描述
    然后访问out中的html文件即可。这就是简单的使用。如果觉得生成文档不好看,还有模板,这个就需要另外搜了。
©️2020 CSDN 皮肤主题: 游动-白 设计师:上身试试 返回首页