四月 8, 2018

使用JSDoc 生成JS API文档

安装jsdoc

  1. 首先是安装jsdoc
npm install jsdoc -g
  1. 去指定文件(如 test.js)的路径下运行
    >文档即可被生成在根目录下的 out 文件夹中。

生成完整项目的文档

  1. 在项目的跟目录下添加conf.json文件。然后添加如下配置内容。
{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "include": ["./src/lib", "./src/util"],
        "exclude": ["./src/lib/demo"],
        "includePattern": ".+\\.js$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "opts": {
        "recurse": true
    }
}

对于配置文件的详细解释可以参见官方文档的说明,这里也是举一个简单的例子:

  1. 生成全局文档。
    进入跟目录,然后执行如下命令,生成全局文档。
jsdoc -c conf.json

注意事项

  1. 所有需要在文档中出现的类名、属性、方法都需要按照jsdoc的规范生成注释块。如果没有注释块,那么不会在文档中生成。

参考链接:https://malcolmyu.github.io/malnote/2015/04/25/Introduction-of-Jsdoc/

Posted in web

发表评论

电子邮件地址不会被公开。 必填项已用*标注