软件编码设计标准规范.doc

《软件编码设计标准规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、b4ec1b53952bbe650718308609ef6022.doc软件编码设计规范1．1．编写目的：使用统一编码约定集的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。编码约定的目的是使程序易于阅读和理解，而不是用过份的约束和绝对的限制来束缚程序员本身的创造性。1．2内容：程序设计语言的特性和风格会直接影响到软件的质量和可维护性。编码原则：应尽量避免在系统初始化

2、时运行过多的代码。（此处加入详细原则）（1）选用控制结构只准许一个入口和一个出口。（2）程序语句组成容易识别的块，每块只有一个入口和一个出口。（3）复杂的结构应该用基本控制结构进行组合嵌套来实现。（4）语句中没有的控制结构，可用一段等价的程序段模拟，但要求该程序段在整个系统应前后一致。（5）严格控制GOTO语句，仅在下列情形才可使用。u用一个非结构化的程序设计语言去实现一个结构化的构造。u在某种可以改善而不是损害程序可读性的情况下。1．2．1对象命名约定公式：对象名称=对象前缀+自定义名称（自定义名称要有一定的意义且第一个字母大写）说明：如果是不需要对其编码的对象，那么对象名用默

3、认对象名。应该用一致的前缀来命名对象，使人们容易识别对象的类型。下面列出了Delphi支持的一些推荐使用的对象约定。（1）推荐使用的项目前缀控件类型前缀例子ClassModulecmdlcmdlCheckDataEnvironmentdevdevPrintsDataReportdrtdrtEnglishFormfrmfrmEntryMDIFormmfrmmfrmSinoexportModulemdlmdlConnectionProjectpjtpjtCkmis第4页共9页b4ec1b53952bbe650718308609ef6022.doc（2）推荐使用的控件前缀控件类型前缀例

4、子3DPanelpnlpnlGroupADODataadoadoBiblioAnimatedbuttonanianiMailBoxCheckboxchkchkReadOnlyComboboxdrop-downlistboxcbocboEnglishCommandbuttoncmdcmdExitCommondialogdlgdlgFileOpenCommunicationscomcomFaxControl（当特定类型未知时，在过程中所使用的）ctrctrCurrentDatadatdatBiblioData-boundcomboboxdbcbodbcboLanguageData-b

5、oundgriddbgrddbgrdQueryResultxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx（3）推荐使用的数据访问对象的前缀用下列前缀来指示数据访问对象。数据库对象前缀例子ConnectionconconReportsxxxdbdbAccounts一些例子：（此处加入例子）（4）推荐使用的菜单前缀应用程序频繁使用许多菜单控件，对于这些控件具备一组唯一的命名约定很实用。除了最前面"mnu"标记以外，菜单控件的前缀应该被扩展：对每一级嵌套增加一个附加前缀，将最终的菜单的标题放在名称字符串的最后。下表列出了一些例子。菜单标题序列菜单处理

6、器名称（此处加入标题序列及处理器名称）当使用这种命名约定时，一个特定的菜单组的所有成员一个接一个地列在VisualBasic的“属性”窗口中。而且，菜单控件的名字清楚地表示出它们所属的菜单项。（5）为其它控件选择前缀对于上面没有列出的控件，应该用唯一的由两个或三个字符组成的前缀使它们标准化，以保持一致性。只有当需要澄清时，才使用多于三个字符的前缀。例如，（此处加入例子）第4页共9页b4ec1b53952bbe650718308609ef6022.doc1．2．2常量和变量命名约定公式：常量或变量名称=常量或变量范围前缀+常量或变量类型前缀+自定义名称（自定义名称要有一定的意义且第

7、一个字母大写）除了对象之外，常量和变量也需要良好格式的命名约定。本节列出了（此处加入变量列表）。变量应该总是被定义在尽可能小的范围内。全局(Public)变量可以导致极其复杂的状态机构，并且使一个应用程序的逻辑非常难于理解。全局变量也使代码的重用和维护更加困难。Delphi中的变量可以有下列范围：范围声明位置可见位置过程级（此处加入名称）模块级（此处加入名称）全局（此处加入名称）。较好的编码习惯是尽可能写模块化的代码。例如，如果应用程序显示一个对话框，就把要完成这一对话任务所需要