在项目开发过程中,需要合适的工具来生成doc文件,通过google以及试用,发现jsdoc-toolkit和ext-doc2个工具比较有意思。
下面详细介绍下jsdoc-toolkit在实际工程中的应用
官方地址为:http://code.google.com/p/jsdoc-toolkit/
相关注释标签为:http://code.google.com/p/jsdoc-toolkit/w/list
jsdoc-tookit解压后分为4个目录,6个文件。其中templates目录为doc html的模板,如有兴趣和需要可以对模板进行修改和定制。
为了能在ant脚本中使用jsdoc-toolkit,还需要额外的2个包:
jsdoc-toolkit-ant-task.jar,下载地址为:http://code.google.com/p/jsdoc-toolkit-ant-task/;
js.jar,下载地址为:https://developer.mozilla.org/en/Rhino_downloads_archive.
一.在eclipse中新建工程如图所示:
其中:
build目录为ant脚本(build-doc.xml),配置文件(build.properties),将ant的变量改为外部应用,以便替换和更改。
doc为jsdoc将来生成doc文件的目录。
jssrc为js源代码文件的存放目录类似于java的源代码文件存放目录为src。
lib为工程中将要使用的额外的jar包,其中build为编译环境所依赖的,有别于运行环境所依赖的包。
在lib中存在着jsdoc-toolkit解压后的文件以及jsdoc-toolkit-ant任务扩展包,以及mozilla旗下的js包,下载后将zip包中的js.jar解压出来即可。
二.配置build.properties如下所示:
##\u5de5\u7a0b\u6839\u76ee\u5f55 project.dir=.. ##\u4f9d\u8d56\u5305 lib.dir = ${project.dir}/lib lib.build.jsdoc= ${lib.dir}/build/jsdoc-toolkit-ant-task-1.1.2.jar lib.build.js=${lib.dir}/build/js.jar jsdoc.home=${lib.dir}/build/jsdoc_toolkit-2.4.0/ doc.dir=${project.dir}/doc src.dir=${project.dir}/jssrc
三.配置build-doc.xml如下所示:
<?xml version="1.0" encoding="UTF-8"?> <project name="test" default="jsdoc"> <description>test</description> <!--导入配置文件 --> <property file="build.properties" /> <taskdef name="jsdoctoolkit" classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit"> <classpath> <pathelement location="${lib.build.jsdoc}" /> <pathelement location="${lib.build.js}" /> </classpath> </taskdef> <tstamp> <format property="build.time" pattern="yyyy-MM-dd-HH-mm" /> </tstamp> <!-- ================================= target: init ================================= --> <target name="init"> <tstamp /> <delete dir="output" /> </target> <!-- ================================= target: doc ================================= --> <target name="jsdoc" depends="init"> <jsdoctoolkit jsdochome="${jsdoc.home}" template="jsdoc" outputdir="${doc.dir}" inputdir="${src.dir}" /> </target> </project>
四.在jssrc下编写demo.js、demo2.js
仅仅示例,demo.js使用的是jsdoc-toolkit中http://code.google.com/p/jsdoc-toolkit/wiki/CookBook的第一个示例代码,demo2.js是基于demo.js上稍加修改的。
demo.js
var MyClass = Class.create( /** @lends MyClass# */ { /** * Description of constructor. * @class Description of class. * @constructs */ initialize : function(arg0, arg1) { //... }, /** A method. */ myFunc : function() { }, /** An instance field. */ myVar : 123 }); // ... and if you want to add class fields ... Object.extend(MyClass, /** @lends MyClass */ { /** A class method. */ classFunc : function() { } });
demo2.js
var MyClass2 = Class.create( /** @lends MyClass2# */ { /** * Description of constructor. * @class Description of class. * @constructs */ initialize : function(arg0, arg1) { //... }, /** A method. */ myFunc2 : function() { }, /** An instance field. */ myVar : 123 }); // ... and if you want to add class fields ... Object.extend(MyClass2, /** @lends MyClass2 */ { /** A class method. */ classFunc2 : function() { } });
五.在build-doc.xml右键,在弹出的菜单中选择"Run As"->"Ant Build"
六.控制台信息
七.doc效果展示
总结:jsdoc-toolkit是一款简单、容易上手的javascript api生成工具。支持是现在流行的多种js oop编写方式,详见http://code.google.com/p/jsdoc-toolkit/wiki/CookBook。
相关推荐
NULL 博文链接:https://gogo1217.iteye.com/blog/1164746
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。它是google 推荐的JsDoc生成工具。
表达jsdoc-swagger 使用此库,您可以使用来记录您的快速端点,而无需编写YAML或JSON。 您可以在每个端点上编写jsdoc注释,该库将创建swagger UI。 先决条件 该库假定您正在使用: 安装 npm i express-jsdoc-...
NULL 博文链接:https://zhangzhaoaaa.iteye.com/blog/2178452
前端开源库-jsdoc-webpack-pluginjsdoc webpack插件,jsdoc webpack插件
VueJS的JSDoc 一个JSDoc插件,用于列出* .vue文件中的道具,数据,计算数据和方法。 要求 节点10+ Vue 2 安装 $ npm install --save-dev jsdoc jsdoc-vuejs 您还需要安装与您的Vue版本匹配的... 使用以下标记之一更
前端开源库-grunt-jsdoc-to-markdowngrunt jsdoc to markdown,markdown api文档生成器,适合Github项目
Java JsDoc Toolkit v2.0文档工具下载,可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,这款工具也是google 极力推荐的JsDoc输出工具。
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
前端开源库-jsdoc-xjsdoc-x,解析器,用于通过jsdoc的explain(-x)命令从文档代码中输出定制的javascript对象。
szn-util-jsdoc2 Javascript 自动文档工具 jsdoc-toolkit-2 debian 包源码 # git clone git@github.com:seznam/szn-util-jsdoc2.git# cd szn-util-jsdoc2# dpkg-buildpackage -us -uc -rfakeroot
NULL 博文链接:https://blueskylan.iteye.com/blog/353482
村上试图模仿 jsdoc3 的 haruki 模板的 JSDOC-Toolkit 模板。 #要求[json2.js](包含) 以及一些 JSDOC 格式的代码。 #理由JSdoc3 不使用 jsdoc 处理任意文件JSdoc2 处理@name 标签不错,但是没有json 输出#这个...
jsdoc_toolkit Cocos2d-JS API jsdoc_toolkit 1. 克隆jsdoc_toolkit.git仓库 2. 拷贝仓库到cocos2d-js仓库下frameworks/cocos2d-html5/tools/目录下 3. 打开终端 cd 到 jsdoc_toolkit。 输入 ant 回车
用于 jsdoc-to-markdown 的西兰花插件安装$ npm install --save broccoli-jsdoc-to-markdown用法JavaScript var broccoli - jsdoc - to - markdown = require ( 'broccoli-jsdoc-to-markdown' ) ;broccoli - jsdoc -...
JSDoc 模板这是一个非常接近默认模板的 jsdoc 模板。变化添加引导程序和一些样式更改。 使用下拉菜单修复了导航栏。 修复了当前页面元素的内联导航。用法 jsdoc -t /path/to/jsdoc-template如果您使用 grunt-jsdoc,...
该插件添加了新的jsdoc规则,专门用于将jsdoc与checkJs和jsdoc注释一起使用。 规则: require-class-field 这将强制您的类具有类字段声明。 此语法仅在节点12及更高版本中有效。 规则: require-constructor-...
jsdoc-vuedoc jsdoc插件使用@ vuedoc / md。 依赖项[电子邮件保护]:支持异步/等待功能。 @ vuedoc / md。 安装npm i jsdoc-vuedoc -D或jsdoc-vuedoc jsdoc插件使用@ vuedoc / md。 依赖项[电子邮件保护]:支持异步/...
jsdoc-tsd 安装 您可以从npm安装此模块: $> npm install @otris/jsdoc-tsd 用法 要使用此模块,只需将这个项目指定为jsdoc输出的模板。 要从命令行使用此模板,请运行 $> jsdoc -t node_modules/@otris/jsdoc-...