更新记录
1.0.1(2022-05-03) 下载此版本
修改插件配置文件位置
1.0.0(2022-05-03) 下载此版本
jsdoc生成(jsdoc文档):
内置docdash模板
平台兼容性
HBuilderX最低兼容版本 |
---|
2.7.0 |
HBuilderX插件通用注意事项
HBuilderX-2.7.12以下版本安装插件市场内的插件后,卸载时需手动卸载,详细教程参考:如何手动卸载插件
jsdoc工具
使用说明:
- 选中项目管理器中的目录,鼠标右键菜单;
- 点击jsdoc,默认会选中当前目录下的
*.js
文件(PS: 不支持ts文件); - 然后就会看到当前项目根目录下生成一个out文件夹,index.html就是你所选中的文件夹下的
*.js
的文档说明(PS: 每次执行jsdoc命令时,不会删除out目录,如果发现输出结果有问题,需要手动删除out目录); - 支持用户自定义include、exclude(需要用户在生成的项目下建
jsdoc.json
文件)
jsdoc.json:
此json文件会识别src目录下的*.js
文件,排除node_modules目录下的*.js
文件(PS: include默认为当前操作的文件夹,exclude默认为[node_modules/|docs]文件夹);
{
"include": ['src'],
"exclude": ['node_modules']
}