需求
将js和ts的代码注释生成api文档
思路
先将ts转成js,再统一处理js文件,用jsdoc工具来生成html文件。
JsDoc
是js文档生成工具,它从javascript程序源代码中抽取类、方法、成员等注释信息形成一个和源代码配套的API帮助文档。Java开源项目,它是一个功能强大的javascript文档生成工具。https://www.shouce.ren/api/view/a/13232
使用实例
通过jsdoc将js文件转成html文件
./node_modules/jsdoc/jsdoc.js -c .jsdoc
-c 或 --configure:指定JSDoc配置文件的路径。默认为安装JSDoc目录下的conf.json或conf.json.EXAMPLE