JavaScript文档生成工具
作者：realazy 来源：realazy 发布时间：2007-10-26 11:59:00
标签：JavaScript,工具
如果你看过YUI的RAW源码，会发现很多跟javadoc语法类似的注释。据说(via)是使用JSDoc这个工具。但我探索了一遍，发现YUI多出很多tag, 比如@namespace, @static之类，那么我只好怀疑YUI做了改良。一开始，我也试着使用了一下JSDoc，遗憾的是，除了缺少一些tag外，它还不支持未匿名函数内的文档生成。比如，有时候为了保证不产生额外的全局变量会这么写：
(function(){
/**
* 注释
* @tag
*/
....
})();或者我所喜欢的”module pattern“:
var module = function(){
var private;
return {
/**
* 注释
* @tag
*/
pub1: function(){},
pub2: function(){},
...
}
}();
在这种情况下，在匿名函数内，和在return区块内的注释，JSDoc就，用北京话说，“葛屁”（音）了，就是不起作用了。遗憾的是我的水平尚未上升到改良perl脚本以能按我所需的程度，因此，我寻找的是下一个目标。
JsDoc Toolkit是一个不错的选择，虽然名称跟JSDoc不太容易区分。相比之下，它是使用JavaScript来处理文档的（当然，得通过rhino），而且支持我前面所列举的两种形式（单是这点，我就只能选择它了）。
两者在tag的处理方面有所不同，感觉JSDoc的全面一些，但缺乏某些关键的tag，比如JsDoc Toolkit中的@scope就很好用。
至于如何安装使用，直接上官网看吧 。欢迎同我交流。
粗粗看了一下jQuery，似乎它也是通过rhino来处理文档生成的，嗯，我也得钻研一下，hack出符合我要求的工具了。
0
投稿猜你喜欢
- /* * zoomCheck */jQuery(function($){ var dCheck = $(&q
- 见以下两个文件：showimage.asp Change the HTTP header
- JSON 相关概念：序列化（Serialization）：将对象的状态信息转换为可以存储或可以通过网络传输的过程，传输的格式可以是JSON，
- 1、列表的创建与遍历与整数和字符串不同，列表要处理一组数据。因此，列表必须通过显式的数据赋值才能生成，简单将一个列表赋值给另一个列表不会生成
注：因为最近想用一下Python做一些简单小游戏的开发作为项目练手之用，而Pygame模块里面提供了大量的有用的方法和属性。今天我们就在之前- 区域（Area）是一个 ASP.NET MVC 功能，用于将相关功能组织为一个单独的命名空间（用于路由）和文件结构（用于视图）。使用区域通过
- 从视频中提取音频安装 moviepypip install moviepy相关代码：audio_file = work_path +
- 本文是 OpenCV图像视觉入门之路的第7篇文章，本文详细的进行了图像的缩放 cv2.resize()、旋转 cv2.flip()、平移 c
- requests相比urllib，第三方库requests更加简单人性化，是爬虫工作中常用的库requests安装初级爬虫的开始主要是使用r
- django常见数据库配置错误出现报错代码为1045的这类几乎都是数据库配置出错报错1django.db.utils.Operational
- 我们已经了解到MySQL可以通过 LIKE ...％ 来进行模糊匹配。MySQL 同样也支持其他正则表达式的匹配， MySQL中使用 REG
- 简单的2048小游戏不多说，直接上图，这里并未实现GUI之类的，需要的话，可自行实现：接下来就是代码模块，其中的2048游戏原来网络上有很多
- MaxDB和MySQL是独立的数据库管理服务器。系统间的协同性是可能的，通过相应的方式，系统能够彼此交换数据。要想在MaxDB和MySQL之
- 在网上查找大量资料，经过自己的不懈努力，终于测试成功了。原来要在服务器上安装mysql odbc 3.51 ，还有数据库用户名及密码，用下面
- 如何比较两个go对象完全相同在go语言中，要比较两个对象是否完全相同，我们可以使用以下三种方法：方法一：使用reflect.DeepEqua
- 非Data Guard的补丁安装教程可参考《[Oracle] CPU/PSU补丁安装详细教程》，Data Guard需要Primary和St
- 一、网络爬虫网络爬虫又被称为网络蜘蛛（🕷️），我们可以把互联网想象成一个蜘蛛网，每一个网站都是一个节点，我们可以使用一只蜘蛛去各个网页抓取我
- 前言综合前述的类、函数、matplotlib等，完成一个随机移动的过程（注意要确定移动的次数，比如10万次），每次行走都完全是随机的，没有明
- 不能将 SQL Server 2000 日志传送配置升级到 SQL Server 2008。数据库维护计划向导是 SQL Server 20
- DataFrame是一个组织成命名列的数据集。它在概念上等同于关系数据库中的表或R/Python中的数据框架，但其经过了优化。DataFra
