JS代码文档生成工具有多种,包括Jsduck、JSDoc、YUEDoc等,具体各自优缺点详见(Javascript自动化文档工具:YUI Doc, JSDoc 3, JSDuck等比较)。本文着重介绍Jsduck 。
Jsduck 安装
首先下载Jsduck.exe,这些都是jsduck的发布版本。然后将Jsduck.exe放到某个文件夹下,配置环境变量(计算机属性-高级-环境变量-系统变量中的path),在path中添加Jsduck所在的文件夹。
然后测试是否安装好,打开cmd,输入jsduck –help(如果你的jsduck.exe有版本号,例如jsduck-5.3.4.exe,去掉-5.3.4,或者cmd中输入完整的jsduck-5.3.4)。返回下图,则安装成功。