BO前端展示開發(fā)規(guī)范.doc

《BO前端展示開發(fā)規(guī)范.doc》由會(huì)員分享，可在線閱讀，更多相關(guān)《BO前端展示開發(fā)規(guī)范.doc（5頁珍藏版）》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。

第4章 附件：Brio Query編程規(guī)范 4.1 Brio Query編程規(guī)范 為了提高編碼的效率和標(biāo)準(zhǔn)化程度，增強(qiáng)代碼的可讀性，本規(guī)范作為本期深交所中心數(shù)據(jù)庫市場(chǎng)分析系統(tǒng)Brio Enterprise程序員開發(fā)規(guī)范。 4.2 命名規(guī)范(Naming Conventions) 在命名規(guī)范中，約定統(tǒng)一的命名規(guī)則如下： s 命名要有意義、具有描述性，避免含糊，具有可讀性。 s 使用全名。不要因?yàn)橄肷贀翩I而任意節(jié)略，除非公認(rèn)的標(biāo)準(zhǔn)節(jié)略。 s 名稱前后要一致，可擴(kuò)展。 s 每個(gè)有意義的單位(單詞)之間用下劃線分隔。 s 不使用漢語拼音(文件名除外)，必須使用有意義的英文單詞。 s 大小約定： 標(biāo)識(shí)符(Identifier)、對(duì)象(Object)、自定義函數(shù)(User_defined Function)全部小寫。 系統(tǒng)保留字(Reserved Word)、SQL語句應(yīng)大寫。如： BEGIN END; IF THEN END IF； SELECT， INSERT 系統(tǒng)函數(shù)應(yīng)按其固有的格式書寫。主要是每個(gè)意義單位首字母大寫。如： SetTransObject() 4.3 Brio Query文件命名規(guī)范 Brio Query的文件名分為兩類，一類是OCE（Open Catalog Extensions）文件，即數(shù)據(jù)連接文件，應(yīng)連接到的數(shù)據(jù)庫來命名，如連接到的數(shù)據(jù)庫為TESTDB，則OCE文件命名為“testdb.oce”。 另一類是BQY文件，即制作查詢分析報(bào)表文件名，應(yīng)根據(jù)報(bào)表的內(nèi)容來命名，盡量做到簡(jiǎn)潔清晰，如報(bào)表的內(nèi)容為用戶數(shù)統(tǒng)計(jì)，則BQY文件名為“用戶數(shù)統(tǒng)計(jì).bqy”。 4.4 Brio Query對(duì)象命名規(guī)范 Brio Query對(duì)象：指獨(dú)立存在于Brio Query中的各個(gè)對(duì)象，包括查詢區(qū)、結(jié)果區(qū)、表區(qū)、OLAP查詢區(qū)、旋轉(zhuǎn)透視表區(qū)、圖表區(qū)、報(bào)表區(qū)、EIS區(qū)、EIS區(qū)中的控件和圖形以及用戶自定義函數(shù)。 為便于統(tǒng)一識(shí)別，Brio Query對(duì)象命名應(yīng)嚴(yán)格使用標(biāo)準(zhǔn)前綴。 Brio Query所有對(duì)象的命名應(yīng)采用如下標(biāo)準(zhǔn)： _ <變量描述> Brio Query對(duì)象前綴定義及范例如下： Brio Query對(duì)象 前綴 范例 查詢區(qū) q q_sale 結(jié)果區(qū) r r_sale 表區(qū) t t_sale OLAP查詢區(qū) o o_sale 旋轉(zhuǎn)透視表區(qū) p p_sale 圖表區(qū) c c_sale 報(bào)表區(qū) rp rp_sale EIS區(qū) eis eis_sale 用戶自定義函數(shù) f f_connectdb 主數(shù)據(jù)模型區(qū) mdm mdm_sale 控件對(duì)象：指存在EIS中可視的控件對(duì)象。 控件的命名規(guī)范如下： <控件前綴>_ <變量描述> 控件對(duì)象的前綴定義及范例如下： 控件對(duì)象 前綴 范例 命令按鈕 cb_ cb_ok 單選框 rb_ rb_include 復(fù)選框 cbx_ cbx_draft 下接列表框 ddlb_ ddlb_year 列表框 lb_ lb_vendor 文本框 text_ text_employee 圖片對(duì)象：指存在于EIS區(qū)中可視圖片的對(duì)象。 圖片對(duì)象的命名規(guī)范為： <圖片對(duì)象前綴> _ <變量描述> 圖片對(duì)象前綴定義及范例如下： 圖片對(duì)象 標(biāo)準(zhǔn)前綴 范例 線條 gln gln_draft 水平線 ghln ghln_draft 垂直線 gvln gvln_draft 矩形 gr gr_draft 圓角矩形 grr grr_draft 橢圓形 go go_draft 文本標(biāo)簽 gtl gtl_year 圖片 gg gg_logo 4.5 變量命名規(guī)范 變量的命名規(guī)范如下： <作用范圍>_<變量含義> 作用范圍： 前綴 說明 a 函數(shù)的參數(shù) g 全局變量 l 局部變量 變量含義：簡(jiǎn)明的英文單詞，能表示該變量含義的簡(jiǎn)潔單詞。 4.6 Brio Query語句規(guī)范 4.7 Script語句規(guī)范 Script語句應(yīng)體現(xiàn)循環(huán)或控制的層次，每不同層次之間應(yīng)該用一個(gè)制表符(TAB或二個(gè)空格)區(qū)分，如： //取出結(jié)果區(qū)中第一行第一列的值 for(i=1;i<=ActiveDocument.Sections[”結(jié)果”].RowCount;i++) { var l_value=ActiveDocument.Sections[”結(jié)果”].GetCell(i,1) } 每5、6條Script語句至少應(yīng)該有一條注釋說明。 4.8 函數(shù)注釋規(guī)范 /* FunctionName Description Integer: Description Public/Protected/Private as_Arg1: Description as_Arg2: Description How to use this function. */ 詳細(xì)例子如下： /* f_get_token 分解字符串，返回第一個(gè)單詞(由指定的分隔符確定)， 并從字符串中刪除該單詞以及分隔符 string 字符串的第一個(gè)單詞 函數(shù)的使用方法為： string ls_source, ls_token ls_source = “this is a test string!” ls_token = f_get_token( ls_source, “a” ) 這時(shí)，ls_token的值為”this is “, 并且ls_source的值變?yōu)椤?test string!” source ref需要分解的字符串 separator 確定第一個(gè)單詞的分隔符 */ 4.9 Script注釋規(guī)范 在編寫script語句時(shí)，須遵循以下注釋原則： s 在循環(huán)語句的頭進(jìn)行注釋說明； s 在選擇語句的頭進(jìn)行必要的注釋說明； s 在關(guān)鍵的script語句前進(jìn)行注釋說明； 對(duì)帶返回值的return語句必須對(duì)返回值進(jìn)行說明。 4.10 數(shù)據(jù)模型主題優(yōu)先級(jí) 進(jìn)入查詢區(qū)或數(shù)據(jù)模型區(qū)，點(diǎn)擊菜單條上的“數(shù)據(jù)模型”，在下拉菜單中選擇“數(shù)據(jù)模型選項(xiàng)”，進(jìn)入數(shù)據(jù)模型選項(xiàng)窗口，選擇“主題優(yōu)先級(jí)”頁，對(duì)表進(jìn)行排序。 排序規(guī)則如下： 如果表之間的關(guān)系是星型結(jié)構(gòu)，則將主表放在第一的位置，其它表的排列順序影響不是很大，可按照大小或重要程度進(jìn)行排列，或不進(jìn)行排列。