《编写可维护的 JavaScript》读书笔记第18章:生成文档
2014-01-06 21:17
513 查看
1. JSDoc Toolkit
/** * @namespace 应用程序单体。 */ var MyApplication = { /** * 两个数字的加法 * @param {int} num1 第一个数字。 * @param {int} num2 第二个数字。 * @returns {int} 两个数的和。 * @static */ add: function (num1, num2) { return num1 + num2; } };
JSDoc Toolkit 采用定制的 Rhino 启动器(jsrun.jar)来执行。
语法:
java -jar jsrun.jar app/run.js [file]+ -t=[templates] -d=[directory] [options]
例如:
java -jar jsrun.jar app/run.js core/core.js -t=templates/jsdoc/ -d=./out
通常把配置信息放到属性文件里:
src.dir = ./src lib.dir = ./lib jsdoc.dir = ${lib.dir}/jsdoc-toolkit jsdoc = ${jsdoc.dir}/jsrun.jar jsdoc.run = ${jsdoc.dir}/app/run.js jsdoc.templates = ${jsdoc.dir}/templates jsdoc.output = ./docs
Ant:
<target name="document"> <apply executable="java" failonerror="true" parallel="true"> <fileset dir="${src.dir}" includes="**/*.js"/> <arg line="-jar"/> <arg path="${jsdoc}"/> <arg path="${jsdoc.options}"/> <arg path="${jsdoc.run}"/> <arg line="-t=${jsdoc.templates}"/> <arg line="-d=${jsdoc.output}"/> <srcfile/> </apply> </target>
2. YUI Doc
略。相关文章推荐
- 《编写可维护的 JavaScript》读书笔记第8章:避免“空比较”
- 《编写可维护的 JavaScript》读书笔记第7章:事件处理
- 《编写可维护的 JavaScript》读书笔记第7章:事件处理
- 《编写可维护的 JavaScript》读书笔记第9章:将配置数据从代码中分离出来
- 《编写可维护的 JavaScript》读书笔记第9章:将配置数据从代码中分离出来
- 《编写可维护的 JavaScript》读书笔记第9章:将配置数据从代码中分离出来
- 《编写可维护的 JavaScript》读书笔记第10章:抛出自定义错误
- 读书笔记:编写可维护的javascript
- 《编写可维护的 Javascript》读书笔记(附录 A 部分):Javascript 编码风格指南(1)原始值
- 《编写可维护的 JavaScript》读书笔记第17章:文件精简和压缩
- 《编写可维护的 JavaScript》读书笔记第11章:不是你的对象不要动
- 《编写可维护的 JavaScript》读书笔记第12章:浏览器嗅探
- 《编写可维护的 JavaScript》读书笔记第19章:自动化测试
- 《编写可维护的 JavaScript》读书笔记第8章:避免“空比较”
- 《编写可维护的 JavaScript》读书笔记第13章:文件和目录结构
- 《编写可维护的 JavaScript》读书笔记第15章:校验
- 《编写可维护的 JavaScript》读书笔记第20章:组装到一起
- 《编写可维护的 JavaScript》读书笔记第14章:Ant
- 《编写可维护的 JavaScript》读书笔记第16章:文件合并和加工
- 编写高度可维护javascript代码的几点关键性原则