房管软件编码规则说明书Word格式文档下载.docx

房管软件编码规则说明书Word格式文档下载.docx

《房管软件编码规则说明书Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《房管软件编码规则说明书Word格式文档下载.docx（28页珍藏版）》请在冰豆网上搜索。

2界面设计2

3命名规则5

4排版与可读性8

5注释10

6房管系统特殊要求12

附录1常用控件使用说明16

附录2常用控件前缀列表18

1开发环境设置

4-1:

尽量使用Delphi的标准控件，在Delphi控件不能很好满足要求时可以使用ConsVCL中的控件。

不能随意增加ConsVCL中的控件，尽量使用有源代码的控件。

当ConsVCL中的控件的确需要扩展时，必须保证ConsVCL版本的延续性和一致性。

当需要使用控件时，首先在Delphi自带的标准控件中选择。

当标准控件不能满足要求时要在ConsVCL已有的控件中选择。

在ConsVCL中增加新的第三方控件或修改已有控件的代码时，必须升级版本号同时写清楚本次升级的改动地方。

示例：

6.6.12（28）2002.11.23珠海

修改了dxExEdtr.pas

升级拷贝ConsVCL\DeveloperExpressInc\ExpressInplaceEditors\Delphi6\Sources\dxExEdtr.pas

4-2:

保证Delphi编辑环境重点选项的一致性。

通过使用Tools|EditorProperties菜单，在General页上，设置TabStops为2，保证Tab一次走位为2个字符。

不要选中UseTabCharacter和OptionalFill复选框，这样，制表符就不会被保存。

4-3:

使用版本管理工具来管理源代码。

目前使用SourceSafe来管理源代码。

在本机建立与SourceSafe一致的目录结构并设置为SourceSafe的工作文件夹。

从SourceSafe上获取所有的最新程序，使用GetLatestVersion命令，Makewritable选项不能选上，以保证本地的文件都是只读的，保证不会随意修改。

当需要修改模块时，必须首先CheckOut，以保证自己获得修改权。

修改完成并自测通过之后才能CheckIn。

如果模块修改完成，不能继续保持CheckOut。

新增的模块也要及时添加到SourceSafe中，保证SourceSafe中程序的完整性和可运行性。

4-4:

开发机器一般设置为800*600的分辨率，小字体。

对于特殊的显示器或有特殊需要，可以将分辨率设置为1024*768，但要保证字体是小字体，设计的程序界面的大小必须保证在800*600分辨率下能够完整显示。

4-5:

除非特别原因，项目工程中只有主窗体才自动生成，其他所有窗体必须从ProjectOptions对话框的自动生成列表中删除，通过程序来生成。

在窗体需要生成时才自动生成可以减少内存占用和程序的健壮性。

2界面设计

2-1:

应以WINDOWS颜色（灰色）为主，同一个窗体中除白、黑、灰色之外，其它的颜色总数不宜超过2种（楼房表程序界面除外）。

窗体和控件（除Edit、Memo等编辑控件外）的背景色也宜用灰色。

对于Edit、Memo等编辑控件，一般字体用黑色，背景色用白色，如果只能查阅不能编辑则背景色也宜用灰色以表示不可编辑。

特殊情况：

如果当前窗体全部处于查阅状态，则编辑控件的背景色可以全部为白色，便于观看。

2-2:

有模式窗体宽高比例一般为4：

3，特殊情况可以为3：

4。

有模式Form宽高属性值一般情况为：

Width=640,Height=640*0.75≈480；

如确需变化，按该比例，Width每次增减40，Height每次增减30。

Scaled属性设为False。

特殊情况下，高度可以大于宽度，Width=300,Height=300/0.75≈400；

如确需变化，按该比例，Width每次增减30，Height每次增减40。

2-3:

无模式窗体宽高比例一般为3：

2。

无模式Form宽高属性值一般情况为：

Width=600，Height=400。

Scaled属性设为True。

如果没有特殊要求，一般设置无模式窗体的缺省显示为最大化，设置窗体WindowState:

=wsMaximized。

2-4:

窗体的字体一般为宋体、标准体、9号字、字符集CHINESE。

设置窗体的字体和字符集是为了保证该窗体所有控件字体的一致性和在不同操作系统、不同分辨率、不同系统字体下的一致性。

绝对不要选自己加入的而系统没有的字体。

对于有模式窗体，我们开发机器使用的系统字体是小字体，为了满足在大字体环境下程序良好运行，保证窗体和控件会缩放为原来的大小，需要使用Cons控件组的ResolutionFix控件，并在FormCreate时加入以下代码：

ResolutionFix1.DesignRes:

=96;

//96为小字体时的象素

ResolutionFix1.FixResolution（Self）;

尽量将控件的ParentFont设置成True。

对于ParentFont=False的控件，改变系统字体时，如果想将控件缩放为原来的大小，则需要修改ResolutionFix控件的源代码，目前只支持TLabel。

2-5:

有模式窗体的右下方一般要有“确认”、“取消”等关闭窗体的按钮，无模式窗体一般不需要关闭按钮。

对于有模式窗体，需要有明确的关闭按钮，一般是“确认”、“取消”按钮，按钮放在窗体的右下方。

对于需要有“确认”、“退出”的情况，一般在这两个功能互斥的按钮之间加上一个“帮助”按钮以便区分。

如果有模式对话框只是静态显示一些信息，可以只有一个“确认”按钮。

按钮的标题文字中间不留空格。

无模式窗体一般情况下不需要关闭按钮，一般情况下也不出现其他按钮，但为方便操作，也可以加上一些功能按钮。

2-6:

有模式窗体一般设置为对话框方式，不可以改变大小。

对于业务模块和所有的第三级以后的模块都应该采用有模式窗体。

对于有模式窗体，一般不能改变窗体大小，设置窗体的BorderStyle属性为bsDialog。

如果特殊情况下需要改变有模式窗体的大小，如查看扫描图像的窗体，则设置窗体的BorderStyle属性为bsSizeable，同时需要处理窗体变化时窗体内各控件大小和位置的变化，在Constraints中设置最小高度和宽度的值，一般为90，设置“确认”、“帮助”、“取消”等标准按钮的Anchors属性向右、向下对齐，保证不被窗体盖住。

2-7:

尽量少使用图片，使用的图片要和表达的意思相符，尽量用标准的图片。

工具条按钮可以使用图片（16*16），PageControl的左上方也可以使用标识和美观的图片（32*32），向导界面可以在左边使用较大块的图片。

其他地方一般不用图片，尤其按钮，如果能够写下标题则不用图片。

2-8:

如果操作费时，则需要将鼠标光标变成沙漏形状，操作结束后恢复原状。

把鼠标光标暂时变成沙漏形状，以指示一个漫长的操作，要求用户应该等待。

可以用沙漏光标指示短暂的等待，当操作结束时恢复回原来的鼠标光标形状。

对于长时间的等待，可以考虑使用一个无模式对话框，并在上面显示简短的消息，描述正进行什么处理。

2-9:

可以在界面上不同区域之间加上分隔线控件。

在不同性质、不同功能的界面区域之间可以使用Bevel控件来做分隔线，Bevel控件的shape属性一般设置为bsTopLine或bsLeftLine。

有时也可以使用GroupBox控件来包围一些特定区域。

2-10:

保证所有的输入控件应该按tab键和回车键排序是从左到右，从上到下。

可以逐一修改控件的TabOrder属性或者选中全部的输入控件，复制，删除后再粘贴后来，系统会从上到下，从左到右重新对输入控件的TabOrder属性进行从小到大的排序。

2-11:

保证常用编辑、按钮控件的高度、宽度一致。

Edit控件的Height统一为20，常用的RxLib的两个控件TdateEdit和TRxDBLookupCombo取默认的Height，为23。

按钮的Height统一为25。

Width统一为75。

特殊时可调整。

所有按钮尽可能采用Tbutton，按钮的Caption用中文，后跟括号，加带下划线的英文字母表示加速键。

作为例外，“确认”和“取消”按钮不加加速键。

窗体中可以随TSplitter改变宽度的Paneld的Contraints属性中的MinWidth一般设为30。

窗体中如只有一个容器控件，则该控件的Align属性设为alClient。

如同一层次上还有按钮等其他控件，则Align属性设为alTop。

按钮位于Form的底部时，距底部8个像素。

最右边按钮距窗体右边8个像素。

如果PageContol控件左右没有其他控件，设置Top=8，右边距窗体8个象素。

如果PageContol控件为窗体最上边的控件，设置Left=8。

Form720×

540。

PageControl8×

8，496×

464。

下边有一个关闭按钮Button629×

480，75×

25。

上下左右，Button和PageContol之间都是8。

2-12:

标签控件一般为右对齐，文字内容尽量显示在一行。

Label标签控件一般不采用左对齐，但可以采用左右对齐，文字少的标签可以将文字拆开摆放，一般不在label中的文字之间加上空格，以避免在不同操作系统，不同系统字体、不同分辨率下空格被处理成不同的宽度导致界面失调。

2-13:

信息提示一律使用MessageDlg，不使用ShowMessage和MessageBox。

MessageDlg的四种消息对话框：

提示（mtInformation）、确认（mtConfirmation）、警告（mtWarning）、错误（mtError），各自有不同的侧重点。

提示消息框用于对用户操作的提示或对用户不符合规范输入的提醒，为最常用的方式，按钮为“确认”；

确认消息框是对下一步操作有两种选择时的询问或对于无法恢复原有状态的操作，要求用户确认，按钮为“是”、“否”或“是”、“否”、“取消”；

警告消息框和错误消息框都用于系统出错，但程度不一样，警告消息框用于系统单个功能出错但不影响系统运行或系统因网络、共享等原因功能暂时不能实现时的提示；

错误消息框用于系统错误影响到系统的运行或系统崩溃等严重错误，需退出系统。

按钮为“确认”或“是”、“否”、“取消”或“放弃”、“重试”、“忽略”。

一般情况下，如果不是系统出错尽量少用警告消息框和错误消息框。

2-14:

尽量使用Delphi的标准控件，有时为扩展功能或性能可以使用ConsVCL中的特殊控件，但要保证各处一致。

日期型的控件使用RxLib系列的DateEdit和DBDateEdit。

尽量使用TdxImageEdit或TdxDBImageEdit，因为它带有OnChange事件，以及ESC键自动将值赋成Null，免去一些代码。

打印控件使用ReportBuilder。

复杂的数据网格使用dxdbgrid控件。

常用控件的使用说明见附录1。

2-15:

设计程序时需将输入法关闭，或者保证每个输入控件的ImeName属性为空。

如果设计时的输入法变成输入控件的ImeName指向的输入法则导致系统运行时输入法的跳跃性和不确定性，需要将输入控件的ImeName属性清空。

3命名规则

3-1:

所有的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。

不使用汉语拼音。

名字用字母、数字、下划线组成，且第一