ant结合jsdoc构建js文档—ant入门指南(8)
来源:互联网 发布:知英罗马音 编辑:程序博客网 时间:2024/05/05 14:41
ant结合jsdoc构建js文档—ant入门指南(8)
上一篇教程明河演示了如何使用ant自动压缩文件,今天讲解ant如何ant结合jsdoc构建js文档。
JsDoc Toolkit 是一个将抽离js代码中的注释形成文档的程序,利用ant,你可以自动化打包js文档,需要用到的工具是jsdoc-toolkit-ant-task。调用的过程其实非常简单,整个过程类似ant调用yui-compressor。
下面的代码中,明河通过构建kissy-form库(明河和其他同事一起写的form组件集,目前还在编码阶段)的文档,演示jsdoc的用法。
1.准备
假设你已经下载了jsdoc-toolkit-ant-task,且保证你的js代码风格符合jsdoc要求,比如下面的代码:
<span style="font-family:Microsoft YaHei;">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() {}});</span>
详尽的jsdoc语法说明,请看jsdoc的wiki。
2.定义property
<span style="font-family:Microsoft YaHei;"><!--jsdoc-toolkit所在目录--><property name="jsdoc.dir" location="jsdoc-toolkit/"/><!--源代码目录--><property name="src.dir" location="../src/"/><!--文档输出目录--><property name="output.dir" location="../doc/"/></span>
请根据你本机的情况自行修改目录。
3.调用jsdoc
<target name="render"> <taskdef name="jsdoctoolkit" classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit" classpath="${jsdoc.dir}/jsdoc-toolkit-ant-task-1.1.2.jar;${jsdoc.dir}/java/classes/js.jar"></taskdef> <jsdoctoolkit template="jsdoc" jsdochome="${jsdoc.dir}/" outputdir="${output.dir}/" inputdir="${src.dir}" encoding="utf-8"> </jsdoctoolkit></target>
target目标下有二个任务:taskdef定义jsdockit的程序路径,jsdoctoolkit执行真正的构建任务。
接下来明河简单说明下其关键属性。
属性
说明
template
文档模板
outputdir
文档输出路径
inputdir
js源码目录
encoding
输出文档页面编码,默认是utf-8
depth
程序遍历源码目录的深度,默认是10
完成的构建代码如下:
<project name="doc" default="render" basedir="."><!--jsdoc-toolkit所在目录--><property name="jsdoc.dir" location="jsdoc-toolkit/"/><!--源代码目录--><property name="src.dir" location="../src/"/><!--文档输出目录--><property name="output.dir" location="../doc/"/><target name="render"> <taskdef name="jsdoctoolkit" classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit" classpath="${jsdoc.dir}/jsdoc-toolkit-ant-task-1.1.2.jar;${jsdoc.dir}/java/classes/js.jar"></taskdef> <jsdoctoolkit template="jsdoc" jsdochome="${jsdoc.dir}/" outputdir="${output.dir}/" inputdir="${src.dir}" encoding="utf-8"> </jsdoctoolkit></target></project>
下面是明河构建成功后目录情况:
有机会再给大家讲解常用的jsdoc语法。
注:targetdef用于使用第三方任务。见http://blog.163.com/yang_jianli/blog/static/161990006201272455531446/
转自:http://www.36ria.com/4816
0 0
- ant结合jsdoc构建js文档—ant入门指南(8)
- 构建文件入门—ant入门指南(2)
- 构建文件入门—ant入门指南(2)
- property—ant入门指南(5)
- dataType—ant入门指南(6)
- ant入门指南(1)
- ant入门指南(2)
- ant入门指南(3)
- ant入门指南(4)
- ant入门指南(5)
- ant入门指南(6)
- ant构建和入门
- ANT教程之八 Ant构建文档
- (2.2.6.2)构建工具Ant(一)—入门
- 认识基础任务标签—ant入门指南(3)
- 项目build实战—ant入门指南(9)
- ANT 构建工具低调入门
- Ant—使用Ant构建简单Java项目(一)
- 关于VC++, MFC过时了吗的想法
- 黑马程序员_正则表达式
- spinner简单理解
- gdb简介及简单使用(转自ibm)
- 指针(4)智能指针的使用
- ant结合jsdoc构建js文档—ant入门指南(8)
- struts2类型转换器处理页面传来的用户信息结果报空指针异常
- Android线程模型解析(包括UI的更新)
- JFace 数据绑定
- 编程之美初赛第二场 集合
- 回顾四叉树LOD地形(上)
- 使用GestureOverlayView时背景透明的方法,加载在别的View之上
- LeetCode Decode Ways
- 纯城市成都市