JavaScript文档生成工具
作者:realazy 来源:realazy 时间:2007-10-26 11:59:00
如果你看过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出符合我要求的工具了。
标签:JavaScript,工具
0
投稿
猜你喜欢
IE6下的CSS BUG枚举
2010-06-11 10:45:00
python输出数组中指定元素的所有索引示例
2021-11-27 02:21:09
Python类的基本写法与注释风格介绍
2023-01-15 07:53:52
Python自动化测试PO模型封装过程详解
2023-08-23 18:59:49
交互设计实用指南系列(10)—别让我思考
2010-03-01 12:50:00
解析如何在sqlserver代理中配置邮件会话
2024-01-21 20:55:24
Mysql中悲观锁与乐观锁应用介绍
2024-01-15 08:26:30
Python实现Excel自动分组合并单元格
2021-11-06 03:03:41
node.js的事件机制
2024-05-03 15:58:31
SQL Server数据库备份出错及应对措施
2009-04-20 17:02:00
利用Python第三方库实现预测NBA比赛结果
2022-07-01 09:48:29
Python下应用opencv 实现人脸检测功能
2022-09-18 00:25:44
asp清理缓存的代码
2011-03-09 11:16:00
SQL Server查询速度慢原因及优化方法
2008-12-03 15:19:00
浅谈python中拼接路径os.path.join斜杠的问题
2023-08-21 23:41:23
pandas实现一行拆分成多行
2021-09-19 16:22:37
原生JavaScript实现网页版计算器
2024-04-23 09:27:08
PyTorch加载模型model.load_state_dict()问题及解决
2022-11-08 07:03:53
出现“不能执行已释放的Script代码”错误的原因及解决办法
2024-04-19 10:02:13
Python简单获取网卡名称及其IP地址的方法【基于psutil模块】
2022-10-07 19:52:15