jsdoc简明使用教程

作者:kun10 发布时间:December 18, 2010 分类:JavaScript

发现自己没有去用过jsdoc,于是找今天这个时间看看。

其实jsdoc的使用并不难。

jsdoc的主页:http://jsdoc.sourceforge.net/

jsdoc的下载地址:http://code.google.com/p/jsdoc-toolkit/

在安装jsdoc之前你要保证你安装过来jre1.6.0 for windows或者是jre 1.5.9 for linux

下载下来,加压压缩包到D:\jsdoc目录,或者是你喜欢的地方

这就算安装好了jsdoc。

下面就说说使用吧!按我们存放的jsdoc的路径,我们这样运行jsdoc

java -jar D:\jsdoc\jsrun.jar D:\jsdoc\app\run.js -a -e=GBK -t=D:\jsdoc\templates\jsdoc -d=..\..\docs mycode.js

mycode.js就是你的js文件的目录路径
-e 是js文件的编码
-d 是jsdoc对应的docs的文件夹
这样就会生成对应的docs

如果你想给一定的目录结构生成docs,你可以这样写jsdoc命令,把js文件的路径替换成一系列路径

..\..\src\core\ ..\..\src\util\ ..\..\src\widget\

这样我们其实可以编写一个简单的dat文件来简单的批量处理创建docs的任务
如下:

java -jar jsrun.jar app/run.js -a -t=templates\jsdoc -e=GBK -d=..\..\docs ..\..\src\core\ ..\..\src\util\ ..\..\src\widget\

很简单吧。

其实要生成漂亮的文档靠的还是你的良好的注释
具体的格式参考这里:http://jsdoc.sourceforge.net/

标签: jsdoc, 工具

添加新评论 »

captcha
请输入验证码