VB.net编码规范(转帖)

踏浪行歌

按：编程规范是程序员在实践中，为维护代码，便于集体开发，制定的一种约定，也是程序开发经验总结。你可以参考、制定自己的规范，但不可拘泥。 在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.net编码规范，是一种被证明能明显改善代码可读性，并有助于代码管理、分类的编码规范。采用这种编码规范，能避免如匈牙利命名法带来的繁长前缀，便于记忆变量的用途。下面的介绍这种编码规范。 2 b4 R& z( z3 w8 l: p% O , f$ \9 ^6 F, Y一、类型级单位的命名 & z U }: W( B Z. A2 F6 B% ~1、类。 / f) ~& D6 B b6 k# s . b8 @0 g% Y" e4 l! j% X, t8 L以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如： Class Indicator 4 `4 z! X$ D& }6 N8 Y 7 W8 o; h2 o( ~+ D' |当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾： Class ColorSetException Class CauseExceptionAttribute % J! t$ H( k3 H) L+ y + O: l- r7 f2 S$ |0 n当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如 Class ScreenClass Class SystemClass 9 M/ k, z( [, h7 [7 i& @+ u& H/ K 2 M4 b, y: T( o* `1 h当类只用于作为其他类的基类，根据情况，以Base结尾： MustInherit Class IndicatorBase 如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page： Class PrintForm : Inherits Form ‘* Windows窗体 / }! p- s# \ g5 n5 k5 DClass StartPage : Inherits Page ‘* Web窗体 / R8 M+ n. G. H2、枚举和结构 : c; G9 Q; x3 ]9 C: Y+ q同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如： Enum ColorButtons ‘以复数结尾，表明这是一个枚举 Structure CustomerInfoRecord ‘以Record结尾，表明这是一个结构体 ; a+ V2 F) o: C- {# n 3、委派类型 普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能： " }( z; Q% P& J# N, R: b" jDelegate Sub DataSeeker (ByVal SeekString As String) 3 F) F; t. l3 z3 w2 P用于事件处理的委派类型，必须以EventHandler结尾，如： Delegate Sub DataChangedEventHandler (ByVal Sender As Object, ByVal e As DataChangedEventArgs) 4、接口 与其他类型不同，接口必须要由I作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力： 7 _9 R3 f3 G' r0 f5 bInterface ISortable 5、模块 模块不是类型，他的名称除了必须以名词命名外，必须加以后缀Module: t5 v1 [: B0 oModule SharedFunctionsModule , c( u, [. [7 V. l P9 X* f$ G上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 二、方法和属性的命名 + M7 s# i0 w1 _$ x% k1 m ' t3 ?! A+ b* `' i( y1、方法 3 s9 X. J3 x& F/ ^+ A0 b8 v- A无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。 Sub Open(ByVal CommandString As String) Function SetCopyNumber(ByVal CopyNumber As Integer) : t6 ?6 w' h( ]9 Q1 ]# B3 b, C( q参数需要指明ByVal还是ByRef，这一点写起来会让程序边长，但非常必要。如果没有特别情况，都使用ByVal。参数的命名方法，参考后面“变量的命名方法”。需要重载的方法，一般不写Overloads，根据需要编写重载的方法。 ! o9 q6 f q6 M2、属性 原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名： 5 \1 e8 k1 z. v8 q/ O5 d* oProperty Concentration As Single . V+ c9 T+ I) m# J& X [/ qProperty Customer As CustomerTypes 0 U2 J& d% z% y" M4 h; F3、事件 事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间： * e. c2 E F; s. {" O7 R/ V# ?Event Click As ClickEventHandler Event ColorChanged As ColorChangedEventHangler . C, h% \ |% V9 V" ~三、变量和常数 常数以表明常数意义的名词命名，一般不区分常数的类型： Const DefaultConcentration As Single = 0.01 在严格要求的代码中，常数以c_开头，如c_DefaultConcentration，但最好不要用它，它会带来输入困难。 + j% ?% p0 v8 z' ~: E) x2 y普通类型的变量，只要用有意义的名字命名即可，不可使用简称和无意义的名称诸如A，x1等，下面给出了良好的例子： 6 i$ i2 z0 U+ `" i9 K: [. K6 U0 lDim Index As Integer + o8 ^2 l; a. X% ]% V3 E$ xDim NextMonthExpenditure As Decimal 2 S* l2 D# `0 h+ p9 iDim CustomerName As String 8 N, ]+ z* B6 r7 B" J+ h( A不能起太长的名字，应该尽量简洁，如下面的例子： 2 x) Q! Q" l+ p+ \( S1 b4 UDim VariableUsedToStoreSystemInformation As String ‘* 错误，太复杂了 Dim SystemInformation As String ‘* 正确，简单明了 5 p3 f: T- V, _# ^4 |* i$ W) b: pDim sysInfo As String ‘* 错误，过于简单 7 _! |9 h# Y3 n6 _) T/ K) t特殊情况可以考虑一个字母的变量： ' y+ N; g! T* l: L& KDim g As Graphic ; i& s0 `! b# `( G- }9 m对于控件，应该指明控件的类型，方法是直接在变量后面加以类名： 1 y& r- ?) x, u* pFriend WithEvents NextPageButton As Button ‘* 按钮 1 k( E) n% Y; E- sFriend WithEvents ColorChoicerPanel As Panel ‘* 面版 6 n, H3 w5 p' U+ c' i y0 ~$ MFriend WithEvents CardFileOpenDialog As FileOpenDialog ‘* 文件打开对话框 等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码： # N1 \* E) m- ^* f' pbtnCancel.Text = "&Cancel" 3 r' p* ^$ u* g+ Q0 W% {: HCancelButton.Text = "&Cancel" ) `- ?$ a* ~" ]/ y显然后者更能使阅读者明白变量的类型是一个按钮。 + F$ p6 c$ s: a$ l5 I0 f四、标签 8 V/ X( @( N3 o' C5 w( g标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如： _A_LABEL_EXAMPLE: 如此定义标签是为了与其他代码元素充分区别。 3 q( q8 S! h" S& l0 K7 B 五、名字空间 ; F7 A/ i! E# J6 x 0 f4 d( Y3 F1 ?, L: S/ F通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是： 5 \/ m! D* W6 T+ u5 k! w公司名.产品名[.组件名的复数] # \* T8 }0 P* S" g4 z% f如： Namespace Ninputer.VirtualScreen Namespace Ninputer.CardEditor.CustomeControls 2 h K. v! l$ j8 O; U3 I2 I% y随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。 9 L( A( I8 L! ~) H: o ) Z/ \+ L6 j4 t9 m六、注释 注释的规则繁多，这里仅提到其中一点：正常的注释以‘*开头，单独的‘只用来注释暂时不用的代码 ‘* 这是普通的注释 ‘* 这段代码在调试正确后加入 ‘If UseHighSpeed(g) = True Then .... 8 K! {$ h* r+ w, W) K! m9 I这样能够方便的采用代码注释工具控制代码的使用。 以上已经简单的介绍了我使用的VB.net代码规范，这个代码规范也适用于C#。仅供大家参考。