应用程序开发规范.doc

应用程序开发规范 意普软件技术有限公司 应用程序开发规范意普软件技术有限公司 第 1 页 目的目的 制定应用程序开发规范的主要目的 是为了使应用程序源代码的结构和编码风格以及用 户界面统一化 标准化 好的开发规范可使源代码严谨 意义清楚且可维护性强 同时 标准化的界面设计可使用户能更快捷方便地使用软件 PowerBuilderPowerBuilder 8 08 0 部分部分 编码约定编码约定 1 采用统一的缩进风格 缩进值为 2 流程控制语句采用大写方式 例 IF 条件 THEN 处理语句块 END IF 3 PowerBuilder 的函数 对象属性以及其它关键字采用大小写混合方式 即每一单 词的首字母大写 其余字母小写 例 This SetFocus This Visible dw Display SetTransObject SQLCA 4 嵌入式 SQL 语句采用大写方式 例 SELECT csName INTO lsName FROM tbItem WHERE clID 12345 USING SQLCA 5 每一运算符左右均空一格 例 lsMessage Hello lsUserName 6 累加应写为 liNum liNum 1 或者 liNum 7 SQLCA SQLDA SQLSA 均大写 对象命名约定对象命名约定 类型前缀示例 应用程序 none eRMS 应用程序函数 af af CloseDown 应用程序结构 as as OpenWindows 应用程序开发规范意普软件技术有限公司 第 2 页 窗口 w w Frame 窗口函数 wf wf SaveOrder 窗口结构 ws ws Orders 菜单 m m Frame 菜单函数 mf mf CloseSheet 菜单结构 ms ms Sheets 用户对象 u u DataWindow 类用户对象 n n Transaction C 用户对象 cc cc Encryption 可视外部用户对象 vx vx Status 可视 VBX 用户对象 vbx vbx Counter 用户对象函数 of of ChangeDataObject 用户对象结构 os os Pointers 数据窗口 d d Order 查询 q q OrderSummary 工程同应用程序 eRMS 管道 pi pi WatcomToSybase 结构 s s Keys 函数 f f GenerateNumber 函数结构 fs fs PriorNumbers 控件控件命名约定命名约定 控件前缀示例 CheckBoxcbx cbx Confirm CommandBottoncb cb PrintOrder DataWindowdw dw Order DropDownListBoxddlb ddlb RoomStatus DropDownPictureListBoxddplb ddplb RoomStatus EditMaskem em StartDate Graphgr gr BackGround GroupBoxgb gb SortMode HProgressBarhpb hpb Progress HScrollBarhsb hsb Level HTrackBarhtb htb Degree Lineln ln First ListBoxlb lb Orders ListViewlv lb Sales MultiLineEditmle mle Text OLE 2 0ole ole ProcessBar Ovalov ov BackBorder Picturep p BackGround PictureButtonpb pb Exit PictureHyperLinkphl phl HomePage PictureListBoxplb plb RoomStatus 应用程序开发规范意普软件技术有限公司 第 3 页 RadioButtonrb rb Choose Rectangler r Demo RoundRectanglerr rr Demo RichTextEditrte rte Resume SingleLineEditsle sle Password StaticHyperLinkshl shl HomePage StaticTextst st Title Tabtab tab DataWindows TabPagetabpage tabpage First TreeViewtv tv Course VProgressBarvpb vpb Progress VScrollBarvsb vsb Level VTrackBarvtb vtb Degree 可视用户对象 u u Information 可视外部用户对象 vx vx Extend 可视 VBX 用户对象 vbx vbx Communication 变量作用域约定变量作用域约定 范围前缀示例 GlobalggsUserID SharedsssPassword InstanceiilCount LocalllsUserName ArgumentaadbAmount 变量命名约定 设定作用域为 变量命名约定 设定作用域为 Local 数据类型前缀示例 BlobbblbbWordDoc BooleanblbFlag CharacterclcInitial DatedldToday DateTimedtldtStartTime DecimaldcldcCost DoubledbldbCost IntegeriliCount LonglllRowCount RealrlrCost StringslsName TimetltNow UnsignedIntegeruiluiCount UnsignedLongullulRowCount DataStoredsldsFolioDetail 应用程序开发规范意普软件技术有限公司 第 4 页 DataWindowdwldwOrderHeader DataWindowChilddwcldwcServiceReps ListViewItemlvillviFile MailSessionmaillmailMainSession MenumlmMainMenu MenuItemmilmiOpenTable StructurestlstKeys TransactiontransltransServiceReps TreeViewItemtviltviFile WindowwlwParent 可视用户对象 uluButton 类用户对象 nlnTransaction C 用户对象 cclccComputeSalary 可视外部用户对象 vxlvxExtend 可视 VBX 用户对象 vbxlvbxCommunication SQLSQL ServerServer 20002000 部分部分 数据库的命名数据库的命名 数据库的命名应与应用系统的名字相同 如 eRMS eHMIS2000 数据表的命名数据表的命名 数据表的命名以 tb 开头 如 tbUser tbChickInItem 列命名列命名 列命名约定以 c 开头 其后根据的数据类型 分别约定如下 数据类型取值范围前缀示例 Bit0 1 NullcbcbFlag BigInt 263 263 1 clclNumber Int 231 231 1 clclCount SmallInt 215 215 1 ciciPage TinyInt 0 255 ciciAge Money 不使用 SmallMoney 不使用 Numeric 1038 1038 1 cncnAmount 应用程序开发规范意普软件技术有限公司 第 5 页 Decimal 不使用 Real 3 40E 38 3 40E 38 crcrPay Float 1 79E 308 1 79E 308 cfcfSummary DateTime 1753 01 01 9999 12 31 cdcdStartDate SmallDateTime 不使用 Char 0 8000 个字符 cscsUserName VarChar 0 8000 个字符 cscsLocation Text 0 231 1 个字符 ctctMemo Binary 0 8KB 个字节 cbincbinPicture VarBinary 0 8KB 个字节 cbincbinMap Image 0 231 1 个字节 cimgcimgImage nChar 不使用 nVarChar 不使用 nText 不使用 其它数据库对象命名其它数据库对象命名 1 Primary Key 的命名以 PK 开头 后跟表名 如 PK tbUser 2 Foreign Key 的命名以 FK 开头 后跟表名 下划线和序号 如 FK tbChickInItem 1 FK tbChickInItem 2 3 Index 的命名以 IX 开头 后跟表名 下划线和序号 如 IX tbUser 1 IX tbUser 2 4 Check 的命名以 CK 开头 后跟表名 下划线和序号 如 CK tbIDCode 1 CK tbIDCode 2 5 View 的命名以 v 开头 后跟一描述 如 v BillInformation 6 Stored Procedure 的命名以 up 开头 后跟一描述 如 up ComputeSummary 7 Trigger 的命名以 tr 开头 以 tbUser 为例 分别约定如下 AFTER 类型 默认类型 Insert tr tbUser I Update tr tbUser U Delete tr tbUser D INSTEAD OF 类型 Insert tr tbUser RI Update tr tbUser RU Delete tr tbUser RD 应用程序开发规范意普软件技术有限公司 第 6 页 界面设计部分界面设计部分 键盘操作键盘操作 应该使用户不依赖于鼠标 即所有的操作均可由键盘完成 字体字体 显示 报表打印用字体均采用宋体 9 号字 字体颜色统一采用 Black 消息框消息框 采用统一的自定义消息框 同时须正确使用标点符号 快捷方式快捷方式 1 退出 快捷字母为 X 快捷键为 Ctrl Q 2 全部选中 快捷字母为 A 快捷键为 Ctrl A 3 刷新 快捷字母为 R 快捷键为 F5 4 撤消 快捷字母为 U 快捷键为 Ctrl Z 5 剪切 快捷字母为 T 快捷键为 Ctrl X 6 复制 快捷字母为 C 快捷键为 Ctrl C 7 粘贴 快捷字母为 P 快捷键为 Ctrl V 8 新增 快捷字母为 N 快捷键为 Ctrl N 9 插入 快捷字母为 I 快捷键为 Ctrl I 10 保存 快捷字母为 S 快捷键为 Ctrl S 11 删除 快捷字母为 D 快捷键为 Ctrl D 12 打印 快捷字母为 P 快捷键为 Ctrl P 13 查找 快捷字母为 F 快捷键为 Ctrl F 14 帮助主题 快捷字母为 H 快捷键为 F1 15 关于 快捷字母为 A 应用程序开发规范意普软件技术有限公司 第 7 页 16 列表 快捷字母为 L 17 详细资料 快捷字母为 D 菜单菜单 1 菜单尽量参照 WINDOWS2000 的式样 菜单项顺序暂定为 文件 F 编辑 E 其余菜单项 查看 V 工具 T 帮助 H 退出 统一放在 文件 的最后一项 2 注意 各个菜单项