最近看了一下jsdoc方面的文档和资料,也自己亲手试验在了工作项目中,感觉还不错,虽然已经不是什么新奇的东西了,但是我还真是第一次用……
下载安装jsdoc toolkit我就不啰嗦了,开始装的是perl下的jsdoc,运行成功,但是发现语法太严格,也不适合推广比较麻烦,所以又换了后来的jsdoc toolkit,下载非常方便,本地安装了java环境的sdk就可以运行了。
jsdoc的语法参见官方文档http://code.google.com/p/jsdoc-toolkit/w/list
本来以前注释写的就很不规范,看了一圈在自己项目中应用了一下,感觉好多了。
下面讲一下我遇到的问题和解决方法。
首先,不需要每次都cmd下运行,创建built.bat文件,直接写上你的cmd命令就好,我的项目中js写了2个文件,放在src目录下。
md “src/utf-8″ //先创建一个存放utf-8格式的js文件目录
for %%c in (src/*.js) do native2ascii -reverse -encoding utf-8 src/%%c src/utf-8/%%c
//循环这个目录下的js文件,然后全部转编码到utf-8然后存在创建的文件夹下。
java -jar jsrun.jar app/run.js -a -e=utf-8 -t=templates/jsdoc -d=myjsdoc src/utf-8/*.js
//运行jsdoc,指定生成目录和源文件。
rd “src/utf-8″ /s /q
//删除临时的utf-8目录(主要解决我项目中gbk编码的js文件直接doc化有中文乱码的问题)
pause
就这么简单啦~然后看下我导出的文档吧~地址在下面:
http://www.designsor.com/jsdoc/brooklyn/
Read More

Comments