VB.net编码规范(转帖)

踏浪行歌

按：编程规范是程序员在实践中，为维护代码，便于集体开发，制定的一种约定，也是程序开发经验总结。你可以参考、制定自己的规范，但不可拘泥。 4 R; l5 G! D0 ?7 A 在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.net编码规范，是一种被证明能明显改善代码可读性，并有助于代码管理、分类的编码规范。采用这种编码规范，能避免如匈牙利命名法带来的繁长前缀，便于记忆变量的用途。下面的介绍这种编码规范。 6 f w0 m) t+ J, Y. y0 u3 r) M2 K. O( w一、类型级单位的命名 5 }2 \2 p5 `$ p) y 1、类。 % j+ ]! z* @! ]- c, B9 j& Z 以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如： Class Indicator 6 ^$ l" \! H: P; d+ S3 M& v/ A 5 ^# c0 X( u' O当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾： Class ColorSetException Class CauseExceptionAttribute 7 Y9 X6 Q4 J+ V6 ]" O ) C# V5 l) G: r$ }: Q. t2 ?当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如 Class ScreenClass Class SystemClass 当类只用于作为其他类的基类，根据情况，以Base结尾： MustInherit Class IndicatorBase + x8 M+ K; L: g/ J+ d+ z1 B , x3 `8 S( f0 d/ G; m( T$ x; X. Y; w如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page： Class PrintForm : Inherits Form ‘* Windows窗体 Class StartPage : Inherits Page ‘* Web窗体 * \8 }0 f/ P$ H2、枚举和结构 / z# f$ L- Y' f同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如： Enum ColorButtons ‘以复数结尾，表明这是一个枚举 Structure CustomerInfoRecord ‘以Record结尾，表明这是一个结构体 & B+ U! @, K% v: H3、委派类型 普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能： Delegate Sub DataSeeker (ByVal SeekString As String) 4 n. h. Q2 S& t用于事件处理的委派类型，必须以EventHandler结尾，如： Delegate Sub DataChangedEventHandler (ByVal Sender As Object, ByVal e As DataChangedEventArgs) 7 w) i$ O- I+ B0 J9 z4、接口 与其他类型不同，接口必须要由I作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力： . ^' f* b+ S, Y8 v5 g0 m5 Q1 G) P& cInterface ISortable 8 n0 n! y/ F5 w1 X( c* G 5、模块 - ?( W9 O6 ]1 X, V5 Z$ b J模块不是类型，他的名称除了必须以名词命名外，必须加以后缀Module: 5 L. m' X; ]' [% e3 yModule SharedFunctionsModule 上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 二、方法和属性的命名 7 y, Y4 l1 c& \" W! \/ G 1、方法 无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。 ( @1 Y% R, E( e- aSub Open(ByVal CommandString As String) Function SetCopyNumber(ByVal CopyNumber As Integer) ( `/ ^) ~# | @$ ~参数需要指明ByVal还是ByRef，这一点写起来会让程序边长，但非常必要。如果没有特别情况，都使用ByVal。参数的命名方法，参考后面“变量的命名方法”。需要重载的方法，一般不写Overloads，根据需要编写重载的方法。 2、属性 " J" M- c. v$ q( f" [8 q9 P8 f原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名： . P4 @1 f0 t: PProperty Concentration As Single Property Customer As CustomerTypes ( B$ q4 V x' |- u) {$ Z3 Q 3、事件 事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间： Event Click As ClickEventHandler , D& \: X+ f gEvent ColorChanged As ColorChangedEventHangler 1 V3 V) X8 V" E5 n* P' P ; {# D+ S9 c8 b" [4 c- v" \, u; B三、变量和常数 / {; v- \* u I4 V) `( R q ( A& {+ I: l! R5 E1 ~常数以表明常数意义的名词命名，一般不区分常数的类型： Const DefaultConcentration As Single = 0.01 ( Z% V) H( p4 I" K. g3 u* U在严格要求的代码中，常数以c_开头，如c_DefaultConcentration，但最好不要用它，它会带来输入困难。 , x) t) A* n7 h) z3 H4 s普通类型的变量，只要用有意义的名字命名即可，不可使用简称和无意义的名称诸如A，x1等，下面给出了良好的例子： 9 H6 w9 x" i1 ? a0 G& [2 tDim Index As Integer * c$ Y$ j$ M) |/ Z' yDim NextMonthExpenditure As Decimal Dim CustomerName As String _% c E/ R/ S% G不能起太长的名字，应该尽量简洁，如下面的例子： Dim VariableUsedToStoreSystemInformation As String ‘* 错误，太复杂了 & d; G) R+ K7 w+ G' Q9 ]Dim SystemInformation As String ‘* 正确，简单明了 Dim sysInfo As String ‘* 错误，过于简单 # j' V. y* M/ R特殊情况可以考虑一个字母的变量： + T( u+ `9 X+ O7 TDim g As Graphic 对于控件，应该指明控件的类型，方法是直接在变量后面加以类名： # k; o- ]6 J$ E9 A' fFriend WithEvents NextPageButton As Button ‘* 按钮 ' B6 ?8 R+ }: J% O; qFriend WithEvents ColorChoicerPanel As Panel ‘* 面版 + Q) F9 g( t: ZFriend WithEvents CardFileOpenDialog As FileOpenDialog ‘* 文件打开对话框 等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码： btnCancel.Text = "&Cancel" 3 q3 H+ |+ t6 z* k3 s T( v# P4 FCancelButton.Text = "&Cancel" ( x; H: I2 z. B9 f3 ~( D" t显然后者更能使阅读者明白变量的类型是一个按钮。 * s. X1 ]+ v$ F 5 ~& T m' H" R2 j' Z: c四、标签 标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如： _A_LABEL_EXAMPLE: 如此定义标签是为了与其他代码元素充分区别。 1 l6 m6 j& w% `; D 五、名字空间 ; Z |& `" {2 Q7 a1 _+ d" E 2 O! o1 k1 B4 {2 S+ J% ?+ w* g- V( q通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是： , {) } I- ~4 K公司名.产品名[.组件名的复数] 如： ! E% w5 b5 B8 b2 ]+ INamespace Ninputer.VirtualScreen ' X" G6 b* J0 P* D* {7 Z7 ~Namespace Ninputer.CardEditor.CustomeControls 随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。 * t, ?' Z9 W2 N! f 六、注释 / D1 T8 V$ e5 }# h2 C, \$ }注释的规则繁多，这里仅提到其中一点：正常的注释以‘*开头，单独的‘只用来注释暂时不用的代码 ; d! j! ]% ~0 X' M: _‘* 这是普通的注释 : `4 U2 c5 m$ ~; S" K( m‘* 这段代码在调试正确后加入 2 t, p) L7 t- i0 I4 m‘If UseHighSpeed(g) = True Then .... g5 M6 E4 _! U, D' a8 v4 E这样能够方便的采用代码注释工具控制代码的使用。 以上已经简单的介绍了我使用的VB.net代码规范，这个代码规范也适用于C#。仅供大家参考。