?
近期开放测试版下载，敬请关注！
?
?? ? ?Hippo是集代码编辑器、代码格式化、代码打包、代码混淆压缩、批量处理功能于一体的 javascript
代码辅助工具。 拥有独立的javascript语法分析算法，不依赖于第三方插件，目前支持中、英、日三种语
言版本。
?? ? ?Hippo 的代码编辑器支持js文件拖拽打开， 编辑区支持代码的语法着色，代码格式化、打包、混淆压
缩时提供语法错误的准确定位提示。
?? ? ?Hippo 拥有出色的API帮助文档自动生成功能， ?可以根据代码中的注释内容来生成相关的API文档。
更为强大的是， 它可以跨文件进行类之间继承关系的分析， 使得子类中无需重复书写父类方法的注释说明，
大大提高了代码的维护效率。 在JS框架中这种特性体现的更为出色。 当然，这里需要一些注释规范来约束。
别担心，其实并没有多么复杂。Hippo的注释规范与Java的注释规范基本一样。
?
?
类注释的写法
类的注释头必须以 "/***
" 开头， 且包含 "@name?${className}
", 类结尾处必须有 "///EndClass-${cla
ssName} "的注释, 两个"className "必须完全一致(注意大小写);?
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，格式如下。 ? ??
注释中必须有两个关键字：@description、@method，格式如下。 ? ??
例： /** * -EVENT- * @description * 事件的注释说明文本(支持多行) * @method clickRow * 事件回调函数的参数说明... */?
注释关键字的用法与代码格式
Hippo规范的注释关键字共有14个，必须以@开头。 ? ??
@name, @package, @Extends, @author, @version, @since, @method, @return, @description, @syntax, @paramStruct, @pageTag, @param, @link
- @name
类的名称，单行关键字
格式：?@name ?${className}
- @package
类所在的包名，单行关键字
格式：?@package ?${package}
- @Extends
可以指定多个父类，父类之间用空格或逗号隔开，多行关键字
格式：?@Extends ?parentClass1 ,?parentClass2 , ... - @author
作者署名，单行关键字
格式：?@author ?${authorName}
- @version
版本信息，单行关键字
格式：?@version ?${version}
- @since
单行关键字
格式：?@since ?${version}
- @method
方法名称，单行关键字
格式：?@method ?${methodName}
- @return
函数、方法的返回值的类型，单行关键字
格式1：?@return ?${type} ?格式2：?@return ?${type} ?类型的格式说明 - @description
描述文本，多行关键字
格式：?@description ?说明文本 - @syntax
语法格式说明，一般用于静态类，单行关键字
格式：?@syntax ?语法说明文本 - @paramStruct
类参数的结构类型，
这个关键字仅用于类的注释头中，有两个固定值：Array、JSON，单行关键字
格式：?@paramStruct ?${type}
- @pageTag
页面标签名，个关键字仅用于类的注释头中，单行关键字
格式：?@pageTag ?${tagName}
- @param
参数说明
名称、类型和说明文本间用空格分隔，说明文本部分支持多行文本，多行关键字
格式1：?@param ?${paramName} ?${type} ?说明文本
格式2：?@param ?${JSON} :${name} ?${type} ?说明文本
格式3：?@param ?#${paramName} ?${type} ?说明文本
- @link
超级链接关键字，本关键字主要用于各种说明文本中，以建立说明文本间的联系
页内相互链接时，$url ?可以缩写为'# '
格式1： {@link ?$url ?$anchor }?格式2： {@link ?$url } ? ? ? ??
