开发工具
项目地址 https://github.com/jsdoc/jsdoc
官方站点 https://jsdoc.app/
通过js的注释生成文档的工具
全局安装
npm install -g jsdoc
或者安装到项目下
npm install --save-dev jsdoc
使用
jsdoc yourJavaScriptFile.js
使用配置文件
配置文件参考: https://jsdoc.app/about-configuring-jsdoc.html
根据参考创建配置文件,例如 jsdoc.config.json
然后执行如下命令
jsdoc -c jsdoc.config.json
暂时放弃使用/探索
原来是想对小程序项目中的组件自动生成文档,以便于在使用组件时能够更加的清晰,
所以找到了jsdoc,但是期间遇到一些困难:
- 识别不了.ts,可能是缺少了某个plugin。
- 最期望的是能输出 properties: {} 里面值的注释,但是没有输出来,可能配置不对。
也尝试过在ant.design pro 下使用,同样一堆错误。
看jsdoc有15k的star,应该不会差,只是时间有限,暂时放弃探索。
其他
一个中文文档 https://www.jsdoc.com.cn/