JSRookie Web前端展現(xiàn)層項(xiàng)目發(fā)布引擎

1、青島汕昭科技JSRookie Web前端展現(xiàn)層項(xiàng)目發(fā)布引擎JSRookie Web前端展現(xiàn)層項(xiàng)目發(fā)布引擎設(shè)計(jì)文檔一、發(fā)布引擎概述JSRookie Web前端展現(xiàn)層項(xiàng)目發(fā)布引擎（簡稱:JWI）是為JSR Web前端框架量身訂做的項(xiàng)目發(fā)布工具，主要負(fù)責(zé)JSR項(xiàng)目的： API文檔的自動(dòng)生成； 資源樣式文件的壓縮； javascript code 的混淆與壓縮； 日志文件同步的相關(guān)更新；JWI以模板文件夾中的靜態(tài)模板為基礎(chǔ)模型，通過JSR源碼中的代碼注釋部分的內(nèi)容來動(dòng)態(tài)生成API應(yīng)用文檔，利用JSA提供的API方法來實(shí)現(xiàn)對(duì)javascript code的混淆與縮壓。二、發(fā)布引擎結(jié)構(gòu)與模塊劃分1 JWI

2、結(jié)構(gòu)流程圖： 圖1 JWI通過用戶指定的javascript code和控件樣式表的資源路徑，載入JSR的代碼，解析代碼中的注釋部分，經(jīng)文檔模板組織成API文檔，代碼部分由javascript code混淆壓縮模塊生成發(fā)布代碼，輸出到JSR項(xiàng)目發(fā)布文件夾中。三、模塊的詳細(xì)說明1 資源文件加載模塊：主要負(fù)責(zé)以下資源的加載。 API文檔模板資源文件 javascript code 控件樣式表文件 更新日志文件2 API文檔解析生成模塊：每次取出一個(gè)控件類，經(jīng)正則解析出：類頭說明、相關(guān)屬性、相關(guān)方法、相關(guān)事件、應(yīng)用示例的部分，再組織到API文檔模型中，以類名加.html為名輸出文檔。1） 類頭說明包

3、括：類的功能說明，調(diào)動(dòng)的API方式，參數(shù)的格式，參數(shù)屬性的功能與類型說明。2） 相關(guān)屬性包括：控件類的公用屬性的列表及詳細(xì)說明。3） 相關(guān)方法包括：控件類的API方法的列表及詳細(xì)說明。4） 相關(guān)事件包括：控件類的相關(guān)事件的列表及詳細(xì)說明。5） 應(yīng)用示例包括：生成連接本類DEMO的超鏈接。3 javascript code混淆壓縮模塊：利用JSA項(xiàng)目提供的API中的JavaScriptCompressor，對(duì)所有涉及的js代碼進(jìn)行混淆壓縮，以原來的目錄結(jié)構(gòu)和文件名輸出到JSR項(xiàng)目發(fā)布文件夾中。4 控件樣式表壓縮模塊：將原樣式表文檔中的注釋部分與一些空格與換行去掉，保存最短小的形式，方便應(yīng)用JSR

4、的項(xiàng)目的資源文件加載。5 同步更新日志模塊：JSR項(xiàng)目的每次發(fā)布一般是添加了新的功能控件或是對(duì)原有的控件做了修改或調(diào)整，將本次發(fā)布相關(guān)的信息添加到日志文件中。四、javascript中的代碼注釋規(guī)范1類的注釋/* * -CLASS- * name UI.TabPane * package ui.panel.TabPane * description 這是一個(gè)類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 這是一個(gè)屬性 * param propertyName propertyType * since JSR2.0 */3方法的注釋/* * -METHOD- * summary 這是簡要說明 * description 這是一個(gè)方法 * 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事件