Brio开发规范

1.     前言
为了提高编码的效率和标准化程度，增强代码的可读性，本规范作为XXX前端展现程序员开发规范。

 

2.     Brio Query编程规范
2.1.  命名规范(Naming Conventions)
在命名规范中，约定统一的命名规则如下：

s         命名要有意义、具有描述性，避免含糊，具有可读性。

s         使用全名。不要因为想少击键而任意节略，除非公认的标准节略。

s         名称前后要一致，可扩展。

s         每个有意义的单位(单词)之间用下划线分隔。

s         不使用汉语拼音(文件名除外)，必须使用有意义的英文单词。

s         大小约定：

标识符(Identifier)、对象(Object)、自定义函数(User_defined Function)全部小写。

系统保留字(Reserved Word)、SQL语句应大写。如：

BEGIN END; IF THEN END IF； SELECT， INSERT

系统函数应按其固有的格式书写。主要是每个意义单位首字母大写。如：

SetTransObject()

2.1.1.    Brio Query文件命名规范
Brio Query的文件名分为两类，一类是OCE（Open Catalog Extensions）文件，即数据连接文件，应连接到的数据库来命名，如连接到的数据库为TESTDB，则OCE文件命名为“testdb.oce”。

另一类是BQY文件，即制作查询分析报表文件名，应根据报表的内容来命名，尽量做到简洁清晰，如报表的内容为用户数统计，则BQY文件名为“用户数统计.bqy”。

2.1.2.    Brio Query对象命名规范
Brio Query对象：指独立存在于Brio Query中的各个对象，包括查询区、结果区、表区、OLAP查询区、旋转透视表区、图表区、报表区、EIS区、EIS区中的控件和图形以及用户自定义函数。

为便于统一识别，Brio Query对象命名应严格使用标准前缀。

Brio Query所有对象的命名应采用如下标准：

<Brio Query对象标准前缀> _ <变量描述>

Brio Query对象前缀定义及范例如下：

Brio Query对象
 前缀
 范例
 
查询区
 q
 q_sale
 
结果区
 r
 r_sale
 
数据模型区
 m
 m_sale
 
表区
 t
 t_sale
 
OLAP查询区
 o
 o_sale
 
旋转透视表区
 p
 p_sale
 
图表区
 c
 c_sale
 
报表区
 rp
 rp_sale
 
EIS区
 eis
 eis_sale
 
用户自定义函数
 f
 f_connect_db
 

控件对象：指存在EIS中可视的控件对象。

控件的命名规范如下：

<控件前缀>_ <变量描述>

控件对象的前缀定义及范例如下：

控件对象
 前缀
 范例
 
命令按钮
 cb_
 cb_ok
 
单选框
 rb_
 rb_include
 
复选框
 cbx_
 cbx_draft
 
下拉列表框/列表框
 lb_
 lb_vendor
 
文本框
 text_
 text_employee
 

图片对象：指存在于EIS区中可视图片的对象。

图片对象的命名规范为：

<图片对象前缀> _ <变量描述>

图片对象前缀定义及范例如下：（第一个g代表ground）

图片对象
 标准前缀
 范例
 
线条
 gln
 gln_draft
 
水平线
 ghln
 ghln_draft
 
垂直线
 gvln
 gvln_draft
 
矩形
 gr
 gr_draft
 
圆角矩形
 grr
 grr_draft
 
椭圆形
 go
 go_draft
 
文本标签
 gtl
 gtl_year
 
图片
 gg
 gg_logo
 
eis中的结果
 er
 er_dim_bank
 
eis中的旋转透视表
 ep
 Ep_dim_bank
 
eis中的图表
 ec
 Ec_dim_bank
 

2.1.3.    函数及变量命名规范
变量的命名规范如下：

<作用范围>_<变量含义>

作用范围：

前缀
 说明
 范例
 
fn
 函数
 fn_is_leap_year
 
a
 函数的参数
 a_year
 
g
 全局变量
 g_year
 
l
 局部变量
 l_year
 

变量含义：简明的英文单词，能表示该变量含义的简洁单词。

备注：在函数外面使用 var 是可选的；可以通过只给变量赋值来声明一个变量。不过，使用var，是一种值得提倡的编程风格，而且，如果函数中有同名的全局变量，则必须使用 var。

例如：var l_num_hits = 0, l_cust_no = 0

          但是在定义全局变量时则不可使用var，如：g_bank_id = ‘aa’。

 

2.2.  Brio Query语句规范
2.2.1.    Script语句规范
Script语句应体现循环或控制的层次，每不同层次之间应该用一个制表符(TAB或二个空格)区分，如：

//取出结果区中第一行第一列的值

for(i=1;i<=ActiveDocument.Sections["结果"].RowCount;i++)

{

  var lvalue=ActiveDocument.Sections["结果"].GetCell(i,1)

}

每5、6条Script语句至少应该有一条注释说明。

在Brio Script中对进行字符串赋值操作时，使用双引号或者单引号都可以，如：var l_bank_id=”a”与var l_bank_id=’a’效果是一样的。但是如果要在字符串中输入单引号，则会有所不同，如：与var l_bank_id=”a’b’c”等效的语句为var l_bank_id=’a\’b\’c’，即使用单引号来进行字符串赋值时，要使用转义符\才能把单引号作为普通字符输入。

所以在Script语句中进行字符串赋值操作时，约定使用双引号而不使用单引号。

2.2.2.    函数注释规范
/*     FunctionName

       <DESC> Description</DESC>

       <RETURN>   Integer: Description </RETURN>

       <ACCESS>   Public/Protected/Private

       <ARGS>       as_Arg1: Description

                            as_Arg2: Description</ARGS>

       <USAGE>     How to use this function.    </USAGE>

*/

详细例子如下：

/*     f_get_token

       <DESC>分解字符串，返回第一个单词(由指定的分隔符确定)，

              并从字符串中删除该单词以及分隔符</DESC>

       <RETURN> string       字符串的第一个单词</RETURN>

       <USAGE>

              函数的使用方法为：

                     string ls_source, ls_token

                     ls_source = "this is a test string!"

                     ls_token = f_get_token( ls_source, "a" )

              这时，ls_token的值为"this is ", 并且ls_source的值变为" test string!"</USAGE>

       <ARGS>

              source   ref 需要分解的字符串

              separator      确定第一个单词的分隔符</ARGS>

*/

2.2.3.    Script注释规范
在编写script语句时，须遵循以下注释原则：

s          在循环语句的头进行注释说明；

s          在选择语句的头进行必要的注释说明；

s          在关键的script语句前进行注释说明；

s          对带返回值的return语句必须对返回值进行说明。

2.3.  Brio Query界面规范
2.3.1.    总体界面规范
总体界面风格：

s          分辨率：800*600 / 1024*768显示模式

s          颜色：256色以上模式

s          字体：小字体

s          汉字系统均以宋体9号字为标准

2.3.2.    EIS界面规范
在进行EIS界面设计时应遵循以下规范：

所有EIS界面遵循规范：

s          EIS区上的显示字体均采用宋体 , 尺寸为9；

s          数字类型       MS Sans Serif   9

s          字符类型       宋体       9

数据编辑显示风格为：

日期格式：    yyyy-mm-dd

数字：    #，###，###，##0.00 或 #，###，##0

负数：    前景红色，加负号 （格式为 #，###，##0.00 [RED] -#，###，##0.00

2.3.3.    数据模型主题优先级
进入查询区或数据模型区，点击菜单条上的“数据模型”，在下拉菜单中选择“数据模型选项”，进入数据模型选项窗口，选择“主题优先级”页，对表进行排序。

排序规则如下：

如果表之间的关系是星型结构，则将主表放在第一的位置，其它表的排列顺序影响不是很大，可按照大小或重要程度进行排列，或不进行排列。

 

本文来自CSDN博客，转载请标明出处：http://blog.csdn.net/tianhappy/archive/2007/12/21/1957016.aspx