Javascript文档生成
2008-09-16 20:01:37 来源:WEB开发网 闂傚倸鍊搁崐鎼佸磹閹间礁纾归柟闂寸绾惧綊鏌熼梻瀵割槮缁炬儳缍婇弻鐔兼⒒鐎靛壊妲紒鎯у⒔閹虫捇鈥旈崘顏佸亾閿濆簼绨绘い鎺嬪灪閵囧嫰骞囬姣挎捇鏌熸笟鍨妞ゎ偅绮撳畷鍗炍旈埀顒勭嵁婵犲嫮纾介柛灞捐壘閳ь剛鎳撻~婵嬪Ω閳轰胶鐤呯紓浣割儐椤戞瑩宕ョ€n喗鐓曟い鎰靛亝缁舵氨绱撻崘鈺傜婵﹤顭峰畷鎺戔枎閹搭厽袦婵犵數濮崑鎾绘⒑椤掆偓缁夌敻骞嗛悙鍝勭婵烇綆鍓欐俊鑲╃磼閹邦収娈滈柡灞糕偓鎰佸悑閹肩补鈧尙鏁栧┑鐐村灦閹稿摜绮旈悽绋课﹂柛鏇ㄥ灠閸愨偓濡炪倖鍔﹀鈧繛宀婁邯濮婅櫣绱掑Ο璇茶敿闂佺ǹ娴烽弫璇差嚕婵犳碍鏅插璺猴工瀹撳棝姊虹紒妯哄缂佷焦鎸冲畷鎴﹀箻鐠囧弶宓嶅銈嗘尰缁嬫垶绂嶉悙顒佸弿婵☆垳鍘ф禍楣冩倵濮樼偓瀚�

javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。
其官方站点地址:http://jsdoc.sourceforge.net/
Release版的下载地址是:http://sourceforge.net/PRojects/jsdoc
JsDoc是根据Javascript代码中的注释生成相应的帮助文档,它定义了一套注释标签规范。因此在编写Javascript代码时,要根据它能识别的注释标签进行注释。
具体使用方法如下:
1、如果操作系统是windows的用户,需要配置perl环境,推荐安装ActivePerl ,linux/Unix用户则不用配置了。
2、解压缩JsDoc,在命令提示窗口中进入JsDoc所在目录,使用如下命令即可生成Javascript代码的文档。
perl jsdoc.pl test.js
其中test.js是用于测试的js文件,如果成功则在该目录下生成js_docs_out目录,里面包含生成的文档。
3、如果生成失败,产生如下错误信息:
Can't locate HTML/Template.pm in @INC ......
需要配置HTML::Template模块,配置方法为:
进入perl的Package Manager,可以使用命令ppm,也可以点击开始菜单——ActivePerl 5.8.8 Build 817——Perl Package Manager。然后使用install命令安装HTML::Template模块,代码如下:
C:\> ppm
PPM> install HTML-Template
PPM> quit
具体的参数及用法可以查看JsDoc的官方网站。
Tags:Javascript 文档 生成
编辑录入:爽爽 [复制链接] [打 印]赞助商链接