BO前端展示开发规范.doc

第4章 附件：Brio Query编程规范4.1 Brio Query编程规范为了提高编码的效率和标准化程度，增强代码的可读性，本规范作为本期深交所中心数据库市场分析系统Brio Enterprise程序员开发规范。4.2 命名规范(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() 4.3 Brio Query文件命名规范Brio Query的文件名分为两类，一类是OCE（Open Catalog Extensions）文件，即数据连接文件，应连接到的数据库来命名，如连接到的数据库为TESTDB，则OCE文件命名为“testdb.oce”。另一类是BQY文件，即制作查询分析报表文件名，应根据报表的内容来命名，尽量做到简洁清晰，如报表的内容为用户数统计，则BQY文件名为“用户数统计.bqy”。4.4 Brio Query对象命名规范Brio Query对象：指独立存在于Brio Query中的各个对象，包括查询区、结果区、表区、OLAP查询区、旋转透视表区、图表区、报表区、EIS区、EIS区中的控件和图形以及用户自定义函数。为便于统一识别，Brio Query对象命名应严格使用标准前缀。Brio Query所有对象的命名应采用如下标准： _ Brio Query对象前缀定义及范例如下：Brio Query对象前缀范例查询区qq_sale结果区rr_sale表区tt_saleOLAP查询区oo_sale旋转透视表区pp_sale图表区cc_sale报表区rprp_saleEIS区eiseis_sale用户自定义函数ff_connectdb主数据模型区mdmmdm_sale控件对象：指存在EIS中可视的控件对象。控件的命名规范如下：_ 控件对象的前缀定义及范例如下：控件对象前缀范例命令按钮cb_cb_ok单选框rb_rb_include复选框cbx_cbx_draft下接列表框ddlb_ddlb_year列表框lb_lb_vendor文本框text_text_employee图片对象：指存在于EIS区中可视图片的对象。图片对象的命名规范为： _ 图片对象前缀定义及范例如下：图片对象标准前缀范例线条glngln_draft水平线ghlnghln_draft垂直线gvlngvln_draft矩形grgr_draft圆角矩形grrgrr_draft椭圆形gogo_draft文本标签gtlgtl_year图片gggg_logo4.5 变量命名规范变量的命名规范如下：_作用范围：前缀说明a函数的参数g全局变量l局部变量变量含义：简明的英文单词，能表示该变量含义的简洁单词。4.6 Brio Query语句规范4.7 Script语句规范Script语句应体现循环或控制的层次，每不同层次之间应该用一个制表符(TAB或二个空格)区分，如：/取出结果区中第一行第一列的值for(i=1;i=ActiveDocument.Sections”结果”.RowCount;i+)var l_value=ActiveDocument.Sections”结果”.GetCell(i,1)每5、6条Script语句至少应该有一条注释说明。4.8 函数注释规范/*FunctionNameDescriptionInteger: Description Public/Protected/Privateas_Arg1: Descriptionas_Arg2: DescriptionHow to use this function.*/详细例子如下：/*f_get_token分解字符串，返回第一个单词(由指定的分隔符确定)，并从字符串中删除该单词以及分隔符 string字符串的第一个单词函数的使用方法为：string ls_source, ls_tokenls_source = “this is a test string!”ls_token = f_get_token( ls_source, “a” )这时，ls_token的值为”this is “, 并且ls_source的值变为” test string!”sourceref需要分解的字符串separator确定第一个单词的分隔符*/4.9 Script注释规范在编写script语句时，须遵循以下注释原则：s 在循环语句的头进行注释说明；s 在选择语句的头进行必要的注释说明；s 在关键的script语句前进行注释说明；对带返回值的return语句必须对返回值进行说明。4.10 数据模型主题优先级进入查询区或数据模型区，点击菜单条上的“数据模型”