浏览 2040 次
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
|
|
---|---|
作者 | 正文 |
发表时间:2011-09-07
最后修改:2011-09-07
近期开放测试版下载,敬请关注!
Hippo是一款集代码编辑器、代码格式化、代码打包、代码混淆压缩、批量处理功能于一体的 javascript 言版本。 Hippo 的代码编辑器支持js文件拖拽打开, 编辑区支持代码的语法着色,代码格式化、打包、混淆压 缩时提供语法错误的准确定位提示。 Hippo 拥有出色的API帮助文档自动生成功能, 可以根据代码中的注释内容来生成相关的API文档。 大大提高了代码的维护效率。 在JS框架中这种特性体现的更为出色。 当然,这里需要一些注释规范来约束。 别担心,其实并没有多么复杂。Hippo的注释规范与Java的注释规范基本一样。
类注释的写法类的注释头必须以 "/***" 开头, 且包含 "@name ${className}", 类结尾处必须有 "///EndClass-${cla
ssName}"的注释, 两个"className"必须完全一致(注意大小写); 例: /*** * -CLASS- * @name TestClass * 注释内容 */ function TestClass() { } ///EndClass-TestClass 属性注释的写法属性注释中只能识别两个关键字:@description、@param,格式如下。
例: /** * -PROPERTY- * @description * 属性的注释说明文本(支持多行) * @param property boolean */ this.property = true; 方法注释的写法方法注释中必须有两个关键字:@description、@method,格式如下。
例: /** * -METHOD- * @description * 方法的注释说明文本(支持多行) * @method methodA * @return boolean * 参数说明... */ this.methodA = function(a) { return true } 事件注释的写法事件注释一般写在事件设置方法注释之前。
注释中必须有两个关键字:@description、@method,格式如下。 例: /** * -EVENT- * @description * 事件的注释说明文本(支持多行) * @method clickRow * 事件回调函数的参数说明... */ 注释关键字的用法与代码格式Hippo规范的注释关键字共有14个,必须以@开头。
@name, @package, @Extends, @author, @version, @since, @method, @return, @description, @syntax, @paramStruct, @pageTag, @param, @link
声明:ITeye文章版权属于作者,受法律保护。没有作者书面许可不得转载。
推荐链接
|
|
返回顶楼 | |
发表时间:2011-09-07
不错!
这种工具好啊! |
|
返回顶楼 | |