20050729184413Brio报表开发规范.docVIP

目 录 1. 前言 1 2. Brio Query编程规范 1 2.1. 命名规范(Naming Conventions) 1 2.1.1. Brio Query文件命名规范 1 2.1.2. Brio Query对象命名规范 2 2.1.3. 变量命名规范 3 2.2. Brio Query语句规范 4 2.2.1. Script语句规范 4 2.2.2. 函数注释规范 4 2.2.3. Script注释规范 5 2.3. Brio Query界面规范 5 2.3.1. 总体界面规范 5 2.3.2. EIS界面规范 5 2.3.3. 数据模型主题优先级 6 前言 为了提高编码的效率和标准化程度，增强代码的可读性，本规范作为XXX前端展现程序员开发规范。 Brio Query编程规范 命名规范(Naming Conventions) 在命名规范中，约定统一的命名规则如下： 命名要有意义、具有描述性，避免含糊，具有可读性。 使用全名。不要因为想少击键而任意节略，除非公认的标准节略。 名称前后要一致，可扩展。 每个有意义的单位(单词)之间用下划线分隔。 不使用汉语拼音(文件名除外)，必须使用有意义的英文单词。 大小约定： 标识符(Identifier)、对象(Object)、自定义函数(User_defined Function)全部小写。 系统保留字(Reserved Word)、SQL语句应大写。如： BEGIN END; IF THEN END IF； SELECT， INSERT 系统函数应按其固有的格式书写。主要是每个意义单位首字母大写。如： SetTransObject() Brio Query文件命名规范 Brio Query的文件名分为两类，一类是OCE（Open Catalog Extensions）文件，即数据连接文件，应连接到的数据库来命名，如连接到的数据库为TESTDB，则OCE文件命名为“testdb.oce”。 另一类是BQY文件，即制作查询分析报表文件名，应根据报表的内容来命名，尽量做到简洁清晰，如报表的内容为用户数统计，则BQY文件名为“用户数统计.bqy”。 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 函数及变量命名规范 变量的命名规范如下： 作用范围_变量含义 作用范围： 前缀 说明 范例 fn 函数 fn_is_leap_year a 函数的参数 a_year g 全局变量 g_year l 局部变量 l_year 变量含义：简明的英文单词，能表示该变量含义的简洁单词。 备注：在函数外面使用 var 是可选的；可以通过只给变量赋值来声明一