PB编码规范要求.doc

PAGE PowerBuilder编码规范 目 录 TOC \o 1-3 \h \z \u 1系统框架 4 2文件组织 4 3 程序开发规范 5 一、要求及准则 5 二、命名规范 6 三、注释规范 10 四、程序书写规范 11 五、金舟界面规范 13 六、金舟开发规范 17 4数据库 17 5基类 17 程序开发规范考核表 18 附： 22 1系统框架 V2.2版本系统主框架分为以下几个功能区域： 通用菜单栏：完成通用操作的菜单，部分功能在窗口激活的状态下有效； LOGO及窗口工具栏：在没有模式窗口激活的状态下，显示公司logo；否则显示窗口的菜单工具栏； 我的桌面及系统：我的桌面及各系统的图标，通过点击图标可以展开系统功能项； 工作区：窗口功能工作区； 状态栏：显示用户登录信息； 2文件组织 1、应用程序文件 整个系统的目录结构如下所示： JZERP2.2 PFC PICTURE RES SHARED JC … JZERP.INI JZERP_MAIN.PBL PFC是系统提供的基础类库；包含2.1版本中PFC和PFE的文件夹中的内容，其中PFE是PFC的扩展层； PICTUER中存放用户桌面快捷方式的wmf格式的图标； RES中存放各种资源文件，如菜单图标、logo等； SHARED中存放所用的DLL文件； Jzerp_Main.pbl中是整个系统的应用管理器、主框架菜单及MDI窗口； JZERP.INI是系统的初始化文件； 其它子目录中分别存放各子系统的PBL；一般情况下，要求每个pbl模块不应大于1.5MB，过大则应再划分。 2、功能模块文件 每个系统中自定义的PBL，按功能主题进行划分，即将同一功能主题的窗口、数据窗、菜单、函数等发在一个PBL中，划分时尽可能将功能细化，这样便于程序的配置和组织。 如财务系统可以按功能细分为： cw_pzgl.pbl：凭证管理 cw_zz.pbl： 账簿管理 cw_cngl.pbl：出纳管理 cw_bb.pbl：报表 cw_cl.pbl：材料核算 cw_gdzc.pbl：固定资产核算 … 这样可以很灵活地进行产品组织，如财务核算，可以根据企业需要灵活进行配置。 3 程序开发规范 一、要求及准则 1、基本要求 程序结构清晰，简单易懂，单个函数行数不得超过100行； 精简代码，避免垃圾程序； 尽量使用标准库函数和公共函数； 2、编程准则 2.1 变量使用规范 ??1、不允许随意定义全局变量。 ??2、一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。 3、所有变量都必须在类和函数最前面定义，并分类排列。 2.2 数据库操作规范 ??1、查找数据库表或视图时，只能取出确实需要的那些字段。 ??2、使用无关子查询，而不要使用关联子查询。 ??3、清楚明白地使用列名，而不能使用列的序号。 2.3 对象使用规范 ??1、尽可能晚地创建对象，并且尽可能早地释放它。 2.4 模块设计原则 ???1、不允许随意定义公用的函数和类。 ???2、函数功能单一，不允许一个函数实现两个及两个以上的功能。 ???3、不能在函数内部使用全局变量，如要使用全局变量，应转化为局部变量。 ???4、函数与函数之间只允许存在包含关系，而不允许存在交叉关系，即两者之间只存在单方向的调用与被调用，不存在双向的调用与被调用。 二、命名规范 1、基本准则 1.1 概述 ??1、尽量使用标准英文单词，也可以使用中文拼音（缩写），不允许英文单词和拼音混写。 ??2、如果有名词，必须使用单数形式。 ??3、使用大小写混合格式，将连接的几个单词首字母大写。 ??4、必须在3至30个字母以内。 ??5、如果使用缩写，必须使用本规范附录的缩写范例。 1.2 文件命名规范 ??1、文件命名采用主谓结构，首字母大写。 ??2、文件和文件夹的名称应该精确地说明它们的用途。 1.3 函数命名规范 ??1、函数名和方法名以动词开始，首字母大写，如 SaveFileLog。 ??2、在命名函数时包括返回值的说明，如 GetFileName。 ??3、类名和属性名以名词开始，首字母大写，如 EmployeeName。 ??4、在不同的类中的属性，如果它们有相同的作用，则必须使用同样的名称。 1.4 变量命名规范 ??1、所有变量都必须有前缀，前缀使用2—4个字母，全部小写。 ??2、避免与数据字典中的数据元素名相同。 ??3、避免与函数名、方法名、类名和属性名相同。 ??4、避免使变量名为另一个变量名的一部分。 ??5、布尔变量名应该包含 Is，如 blnFileIsFound。 1.5 常量命名