documentation
和JSdoc一样,documentation也是根据代码注释自动构建出项目文档,前提是我们的代码注释必须按照其规范指南,详情参考JSdoc文档。
我们首先安装documentation.js:
yarn add --dev documentation
指令
然后可以执行指令:
./node_modules/.bin/documentation build src/app.js -f md > API.md
会发现在根目录输出了API.md文件。
我们在package.json文件中配置npm scripts执行脚本:
"scripts": { "doc": "./node_modules/.bin/documentation build src/app.js -f md > API.md" }
项目本地安装documentation时,直接在命令行终端执行指令时需要指定./node_modules/.bin/documentation路径,若全局安装则只可直接使用documentation指令。而执行package.json中的脚步,可以直接简写,npm将为我们自动匹配。
点此查看项目源码地址
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持黑区网络。