JSDoc-Tookit入门<br />常胤(lzlu.com)<br />
三招让你能轻松拥有一份炫酷文档<br />Jsdoc_toolkit<br />简单的约定<br />良好的代码注释习惯<br />
JsDoc Toolkit 自动化文档工具<br />一个Google code上的一个开源项目,可以自动从Javascript代码中提取注释生成格式化文档。<br />项目地址:<br />http://code.google.com/p/j...
如何安装<br />安装JDK<br />设置环境变量<br />解压jsdoc_toolkit<br />
如何使用 – 命令参数<br />命令参数列表:<br />http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptions<br />常用命令介绍:<br />-a :为所有的函数都...
如何使用 – bat<br />
如何使用 –注释规范<br />
如何使用 – 示例一<br />
如何使用 – 示例二<br />
如何使用 – 文档模版<br />:: -t=<PATH> or --template=<PATH><br />:: Required. Use this template to format the output.<br />:: 设置模版路...
Q&A<br />
Upcoming SlideShare
Loading in …5
×

jsdoc-toolkit

4,428 views

Published on

一个Google code上的一个开源项目,可以自动从Javascript代码中提取注释生成格式化文档。

Published in: Technology
  • Be the first to comment

jsdoc-toolkit

  1. 1. JSDoc-Tookit入门<br />常胤(lzlu.com)<br />
  2. 2. 三招让你能轻松拥有一份炫酷文档<br />Jsdoc_toolkit<br />简单的约定<br />良好的代码注释习惯<br />
  3. 3. JsDoc Toolkit 自动化文档工具<br />一个Google code上的一个开源项目,可以自动从Javascript代码中提取注释生成格式化文档。<br />项目地址:<br />http://code.google.com/p/jsdoc-toolkit/<br />运行环境<br />- WindowXP<br /> java version "1.6.0_03"<br /> Java(TM) SE Runtime Environment (build 1.6.0_03-b05)<br />- Mac OS X 10.5<br /> java version "1.5.0_19"<br /> Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)<br />
  4. 4. 如何安装<br />安装JDK<br />设置环境变量<br />解压jsdoc_toolkit<br />
  5. 5. 如何使用 – 命令参数<br />命令参数列表:<br />http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptions<br />常用命令介绍:<br />-a :为所有的函数都生成文档 <br />-t:模版路径<br />-d:指定生成文档的路径,默认是当前目录下的out目录<br />- r:=<DEPTH> 设置遍历文件夹的深度<br />-e:设置读写文件的编码<br />-h :帮助<br />②<br />①<br />C:toolsjsdoc-toolkit> java -jar jsrun.jar app/run.js -t=templates/jsdoc -d=my_docs myscripts/*.js -t=templates/jsdoc<br />
  6. 6. 如何使用 – bat<br />
  7. 7. 如何使用 –注释规范<br />
  8. 8. 如何使用 – 示例一<br />
  9. 9. 如何使用 – 示例二<br />
  10. 10. 如何使用 – 文档模版<br />:: -t=<PATH> or --template=<PATH><br />:: Required. Use this template to format the output.<br />:: 设置模版路径<br />set t=templates/jsdoc<br />java -jar jsrun.jar app/run.js -t=%t% -p /myscripts/<br />
  11. 11. Q&A<br />

×