JSRookie Web前端展现层项目发布引擎

1、青岛汕昭科技JSRookie Web前端展现层项目发布引擎JSRookie Web前端展现层项目发布引擎设计文档一、发布引擎概述JSRookie Web前端展现层项目发布引擎（简称:JWI）是为JSR Web前端框架量身订做的项目发布工具，主要负责JSR项目的： API文档的自动生成； 资源样式文件的压缩； javascript code 的混淆与压缩； 日志文件同步的相关更新；JWI以模板文件夹中的静态模板为基础模型，通过JSR源码中的代码注释部分的内容来动态生成API应用文档，利用JSA提供的API方法来实现对javascript code的混淆与缩压。二、发布引擎结构与模块划分1 JWI

2、结构流程图： 图1 JWI通过用户指定的javascript code和控件样式表的资源路径，载入JSR的代码，解析代码中的注释部分，经文档模板组织成API文档，代码部分由javascript code混淆压缩模块生成发布代码，输出到JSR项目发布文件夹中。三、模块的详细说明1 资源文件加载模块：主要负责以下资源的加载。 API文档模板资源文件 javascript code 控件样式表文件 更新日志文件2 API文档解析生成模块：每次取出一个控件类，经正则解析出：类头说明、相关属性、相关方法、相关事件、应用示例的部分，再组织到API文档模型中，以类名加.html为名输出文档。1） 类头说明包

3、括：类的功能说明，调动的API方式，参数的格式，参数属性的功能与类型说明。2） 相关属性包括：控件类的公用属性的列表及详细说明。3） 相关方法包括：控件类的API方法的列表及详细说明。4） 相关事件包括：控件类的相关事件的列表及详细说明。5） 应用示例包括：生成连接本类DEMO的超链接。3 javascript code混淆压缩模块：利用JSA项目提供的API中的JavaScriptCompressor，对所有涉及的js代码进行混淆压缩，以原来的目录结构和文件名输出到JSR项目发布文件夹中。4 控件样式表压缩模块：将原样式表文档中的注释部分与一些空格与换行去掉，保存最短小的形式，方便应用JSR

4、的项目的资源文件加载。5 同步更新日志模块：JSR项目的每次发布一般是添加了新的功能控件或是对原有的控件做了修改或调整，将本次发布相关的信息添加到日志文件中。四、javascript中的代码注释规范1类的注释/* * -CLASS- * name UI.TabPane * package ui.panel.TabPane * description 这是一个类aaabbbb * pageTag * depend ui.panel.TabPane ui.panel.TabPane * example 123.html * paramType JSON * param paraName0 para

5、Type * param paraName1 paraType * param paraName2 paraType * param paraName3 paraType * param paraName4 paraType * param paraName5 paraType paraName2 * author gugao * version 2008-08-08 * since 0.1 */2属性的注释/* * -PROPERTY- * summary 这是简要说明 * description 这是一个属性 * param propertyName propertyType * since JSR2.0 */3方法的注释/* * -METHOD- * summary 这是简要说明 * description 这是一个方法 * method method * return none * param paraName0 paraType * param paraName1 paraType * param paraName2 JSON * param paraName3 paraType paraName1 * param paraName4 paraType paraName2 * since JSR2.0 */4事件