软件开发编程规则.docVIP

软件开发编程规则 2008.8软件开发编程规则 1慨述 为了规范软件开发，提高程序的编写质量和可读性、可维护性，特编制本编程规则。所有编程人员必须执行此规则，系统设计师对程序员有指导、监督、审查责任。 2编程规则 2．1总则 用户界面，做到艺术化、人性化。整体风格应该是简洁、稳重。 程序模块功能单一化。尽量避免采用非标准的或者第三方的ActiveX控件。 数据库接口用ADO。 2．2用户界面 控制窗体应该采用Windows标准形式，多窗口显示，主窗体要有菜单栏、工具栏、状态栏。 对话窗体的布局要按功能区分布，尽量采用图示化来表示对象。颜色的基调是灰白、白和黑，慎用彩色的背景。字体的大小一般应为小5号和9磅，主要功能按钮的名称应该采取“确认”、“放弃”、“撤消”、“退出”。窗体尺寸特别大的，在屏幕的分辨率比较小时应该自动匹配窗体尺寸大小。 2．3编程 2．3．1命名 基本上引用“匈牙利命名法”，参见附录。 ⑴ 子程序和函数名应该体现所要完成的功能，用下划线连接功能名称。比如：Line_CreateBy_P1P2表示由二个点生成一条直线， ⑵ 对象名应该由二部分组成。前缀是对象的性质缩写（一般为三个小写字符），后面是对象的名称。比如：cnnPipe表示管路数据库的连接，rstPipe表示管路数据库表。其中：cnn表示数据库连接对象，rst表示数据库表对象，Pipe是具体的对象名称。前缀除以上二个外，还有以下的命名约定： cnn表示数据库连接对象 rst表示数据库表对象 frm表示窗体。 cmd表示命令按钮。 cur表示当前使用的。 tmp表示临时的。 col表示集合。 obj表示对象。 exl 表示Excel.Application. cad表示AUTOCAD.Application。 sod表示三维实体。 lin表示线条。 dim表示标注。 sel表示选择集。 ⑶ 变量名应该采用显示说明，也即使用As Variant对变量进行声明。变量名应该专业化，如果有冲突，应该使用前缀。前缀有以下的命名约定： str表示字符串。 cmm表示数据库操作命令。 hull表示船体。 pipe表示管路。 duct表示螺旋风管。 elec表示电气。 vent表示方风管。 stru表示钢结构（铁舾装）。 eqp表示设备。 comp表示部件。 stan表示支架。 paint表示涂装。 cabin表示居装（舱室）。 ⑷数据库表名应该采用专业术语，表分二类，第一类是通用的全船适用的或者基础性的表，第二类是各专业用的表，它们的命名规则分别是：第一类表的表名没有前后缀；第二类表的命名规则是带前缀，前缀由一个专业代码和分割符“_”组成，例如（e_System）。专业代码如下： e代表电气。 g代表总体。 h代表船体。 p代表管系。 v代表通风。 s代表钢结构（铁舾装）。 c代表居装（舱室）。 o代表涂装。 2．3．2形式参数 子程序和函数的形式参数应该声明类型。比如： Sub Line_CreateBy_P1P2(P1 As XyzType, P2 As XyzType, LineObj As AcadLine, Doc As AcadDocument, Block As AcadBlock, ByVal ToWhich$) 注意，ByVal声明的参数，一般仅作为输入值，不要出现在等号的左面。 2．3．3定制类 每个产品就是一个定制类。定制类的层次尽量扁平化。产品通过类的对象存取属性和显示模型。定制类必须具有以下属性和方法： ⑴ 属性 Count计数。 Item()对象数组。Item可以是对象名。 ⑵ 方法 Find查找定位。 Delete删除。 AddNew增加。 Save保存。 Search检索。 Draw_2D二维显示。 Draw_3D三维显示。 2．3．4注释 对子程序和函数的功能和形式参数必须写注释。重要的变量必须写注释。 2．3．5 ACAD的图层 ACAD的图层反映了不同专业模型和处理对象。专业模型是指作用于整个船舶模型的，任何程序模块都能参考的，可以获取基本信息但是不能修改的三维实体。处理对象是指本专业程序模块要处理的对象，它们可由程序模块任意处理。 ⑴ 专业三维模型图层 Pipe—管系 Duct—螺旋风管 Vent—方风管 WaySolid—电缆托架 WaySupport—电缆托架脚 EquipSolid—设备 FittingSolid—舾装件 HullSolid—船体 Temp—临时的，比如临时隐藏的对象。 ⑵ 专业对象图层 PipeSolid—管系的管路三维实体 PipeLine—管系的管路线条 PipeAttf—管系的管路连接件和附件 PipeSta