使用jsdoc-toolkit实现JS API文档自动化

王朝学院·作者佚名  2016-05-22
窄屏简体版  字體: 小  |  中  |  大  |  超大  

使用jsdoc-toolkit实现JS API文档自动化在前面的博文中探讨自动化工程问题时,写过基于NodeJS的,使用gulp、grunt的jsdoc插件实现文档自动化。本文探讨基于java环境的自动化实现。

一、Java安装与环境配置关于Java的安装与环境配置,可以参考博文YUI ComPRessor for Sublime text2

二、jsdoc-tookit下载与使用下载链接:jsdoc-tookit,现在地址可能被墙了,可以通过搜索其它渠道下载。下面完成后,解压到工作目录即可。

-> cmd -> 命令行窗口

-> cd到jsdoc-toolkit所在目录(我的是G:\Workspace\jsdoc-toolkit)

-> windows:java -jar jsrun.jar app\run.js -a -t=templates\jsdoc myTest/myTest.js

linux:$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc myTest/myTest.js

-> 运行后生成out(默认)目录

-> 完成自动化API文档。

当然myTest.js文件中的注释需要符合jsDoc规范。 如果我们不想使用默认目录out,可以通过-d命令来设置。

jsdoc-toolkit相关命令参考:

G:\Workspace\jsdoc-toolkit>java -jar jsrun.jar app\run.js --helpUSAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...OPTIONS: -a or --allfunctions Include all functions, even undocumented ones. -c or --conf Load a configuration file. -d=<PATH> or --directory=<PATH> Output to this directory (defaults to "out"). -D="myVar:My value" or --define="myVar:My value" Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar. -e=<ENCODING> or --encoding=<ENCODING> Use this encoding to read and write files. -E="REGEX" or --exclude="REGEX" Multiple. Exclude files based on the supplied regex. -h or --help Show this message and exit. -n or --nocode Ignore all code, only document comments with @name tags. -o=<PATH> or --out=<PATH> Print log messages to a file (defaults to stdout). -p or --private Include symbols tagged as private, underscored and inner symbols. -q or --quiet Do not output any messages, not even warnings. -r=<DEPTH> or --recurse=<DEPTH> Descend into src directories. -s or --suppress Suppress source code output. -S or --securemodules Use Secure Modules mode to parse source code. -t=<PATH> or --template=<PATH> Required. Use this template to format the output. -T or --test Run all unit tests and exit. -u or --unique Force file names to be unique, but not based on symbol names. -v or --verbose Provide verbose feedback about what is happening. -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]... Scan source files with the given extension/s (defaults to js).

转载声明:

本文标题:使用jsdoc-toolkit实现JS API文档自动化

本文链接:http://www.zuojj.com/archives/1064.html,转载请注明转自Benjamin-专注前端开发和用户体验

 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
 
© 2005- 王朝網路 版權所有 導航