惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

V
Visual Studio Blog
Stack Overflow Blog
Stack Overflow Blog
G
Google Developers Blog
Microsoft Azure Blog
Microsoft Azure Blog
Engineering at Meta
Engineering at Meta
L
LangChain Blog
T
The Blog of Author Tim Ferriss
J
Java Code Geeks
Y
Y Combinator Blog
月光博客
月光博客
雷峰网
雷峰网
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
F
Fortinet All Blogs
A
About on SuperTechFans
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
P
Proofpoint News Feed
小众软件
小众软件
H
Help Net Security
Last Week in AI
Last Week in AI
B
Blog RSS Feed
宝玉的分享
宝玉的分享
N
Netflix TechBlog - Medium
博客园 - 叶小钗
The GitHub Blog
The GitHub Blog

博客园 - 爱在戏院前

Unity的shader学习2 Unity的shader学习1 我的webgame戰鬥回放 gvim小操作 - 爱在戏院前 - 博客园 gvim2笔记 gvim笔记 如何保证网站的稳定性 开源了,开放我的仿ext控件集 122个常见问题收集整理(FLASH初学者参见) MYSQL性能优化(转) http协议全解释 Meta标签全解释 - 爱在戏院前 - 博客园 个人js作品集,仿ext风格(改) document.execcommand方法 JavaScript容易犯错的九个陷阱 科学利用时间,为了有效的生活 Sqlite使用说明 表单Input的高级限制级用法 用JavaScript实现MD5,SHA1加密
Javascript文档生成
爱在戏院前 · 2008-09-09 · via 博客园 - 爱在戏院前

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的官方网站。
转自网上