JSDoc3的简单使用
官方网站:https://github.com/jsdoc3/jsdoc/建议不要直接通过“Download ZIP”功能直接下载,而是到Release中下载稳定版本,比如3.2.2下载后,直接解压到某个目录,比如d:\jsdoc然后设置windows环境变量,在path中增加d:\jsdoc,这样我们在那个目录下,都可以执行jsdoc命令了。假设要对d:\js\myjs.js生成
官方网站:https://github.com/jsdoc3/jsdoc/
建议不要直接通过“Download ZIP”功能直接下载,而是到Release中下载稳定版本,比如3.2.2
下载后,直接解压到某个目录,比如d:\jsdoc
然后设置windows环境变量,在path中增加d:\jsdoc,这样我们在那个目录下,都可以执行jsdoc命令了。当然还有个前提,就是windows环境变量中已经把jdk配置好了。
假设要对d:\js\myjs.js生成jsdoc文档,则:
1、打开dos窗口
2、在dos窗口中执行命令:
jsdoc d:\js\myjs.js
回车后,会在d:\js目录下生成一个out文件夹,里面就是html形式的doc了。
如果要对js目录中所有js文件生成文档,则执行:
jsdoc d:\js
如果要对js目录中的个别文件生成文档,则执行:
jsdoc d:\js\a.js d:\js\b.js
如果要指定生成文档的目录,则可以在命令行后继续增加参数: -d d:\out
这个时候,jsdoc是使用的默认模板生成的jsdoc,效果不是很理想,我们需要找到好一点的模板。
执行jsdoc --help,回车,我们会看到该命令支持的所有参数。
jsdoc的完整官方文档:http://usejsdoc.org/
执行jsdoc --debug,回车,我们会看到一个Java窗口程序,好像是Rhino的,不懂,这个窗口跟调试有关。
开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!
更多推荐
所有评论(0)