基于.NET 的程序设计实训 附录二 基于.NET的程序设计编码规约.docVIP

附录二 基于.NET的程序设计编码规约 一、变量命名规则 前缀（小写字母加下划线）表明变量的作用域，无前缀则表明是局部变量或函数的参数。如：m_xx，表示是类的成员变量，控件变量例外。g_xx，表示是全局变量，在VB.NET 中，也可以理解为在整个项目中都可能用到的静态变量。c_xx或者XX，表示是一个常量。 用数据类型全称中的关键字母代表特定的数据类型（一个或多个小写字母）。如表FL2-1所示。 表FL2-1常用数据类型缩写表 常用数据类型/控件缩写 数据类型/控件 n Integer b Boolean str String c Char d Double ob Object lbl Label txt TextBox btn Button cmb ComboBox mnu MainMenu mnuItem MenuItem ds DataSet chk CheckBox dtgd DataGrid tm Timer frm Form pnl Panel gup GroupBox tv TreeView rdo RadioButton lb ListBox tlb ToolBar 二、函数命名规则 函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其中至少有一个动词。 1、应该避免的命名方式： （1）和继承来的函数名一样。即使函数的参数不一样，也尽量不要这么做，除非想要重载它。 （2）一个动词组成，如：Save, Update。改成如：SaveValue, UpdateDataSet则比较好。 2、函数参数的命名规则： （1）函数参数应该具有自我描述性，应该能够做到见其名而知其意。 （2）用匈牙利命名法命名。 三、类命名规则 1、类的命名通常以父类的简写开头。如：FrmXXX可看出该类从Form中继承而来。 2、类名中尽量不要出现下划线。 3、类变量的命名可以参照，如：FrmXXX frmXXX = new FrmXXX()，即首字母小写即可。 四、常见语句书写规则 常见语句书写规则如表FL2-2所示。 表FL2-2 常见语句的书写规范 语句 提倡的风格 If If condition Then statements Else Statements End If For For initialization To end statements Next For Each For Each something in collection statements Next Select Case Select Case(…) case … … case … … Case Else End Select While While condition statements End While Do-Loop Do statements Loop while condition Try-Catch Try statements Catch e As Exception handle exception End Try 同一代码块内的不同逻辑块之间应空一行 do statement1 do statement2 函数与函数之间至少空一行，但不超过三行 五、注释风格 1、注释应该正确、简洁、有重点。 2、应该写优雅的、可读性良好的代码，而不是为玄妙、晦涩的代码写注释。 3、原则上应尽量减少程序体内代码的注释，应该保持代码本身的直接可读性。 4、函数的注释，可以只对Public或者重要的Private函数进行注解。 六、代码组织 代码组织是对整个项目的代码进行整理，使之更加有序。实现类似功能的文件应该放在同一个文件夹中或者同一个项目中。例如，可把整个项目分为以下几个层次： SystemFramework层：提供一些给其他公用的服务，比如说系统日志，应用程序配置，异常处理，调试类等读取Web.config和*.exe.config一般都在这一层。 Common层：把逻辑上的tables抽象成一些类，这些类一般从DataSet继承，生成一些strong typed Dataset，类中不涉及任何数据库操作。 DataAccess层：这一层的类负责与数据库的连接，以Common层对象为媒介读取，更新，添加，删除数据库对象。为Bussiness层提供数据服务。 Bussiness Logic 层：如果需要的话可以分为以下两层，也可以合为一层。 Business Rule层：包含各种商务逻辑和规则。 Business Facade层：提供给UI层所有的系统接口,这一层抽象出了UI层所需要用到的功能。这一层的类可以通过继承M