jsdoc使用自定义配置文件

需要在每个项目的静态资源构建的时,生成对应的注释文档,所以用到jsdoc自定义配置文件,方便查询总结此篇。

一、配置文件,文件名称可自定义,我的叫jsdoc.json;代码如下:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": ["source/js"],
        "exclude": [],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

1、source.include:需要生成注释文档的文件,数组形式
2、source.includePattern:文件名称符合此正则表达式的文件才生成注释文档。
注:其他属性暂时用不到,后续补充。
二、执行jsdoc.json文件
前提:全局安装过jsdoc
命令如下:

jsdoc -d outFileName -c jsdoc.json -r

参数说明:
1、-d 指定注释文档输出路径
2、-c 告诉jsdoc自定义配置文件的位置
3、-r 告诉jsdoc循环source.include文件夹的子目录

目前用到的就是这些,jsdoc比记录的这些强大的太多,挑用到的记录下来,方便查询。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值