VB.net编码规范(转帖)

踏浪行歌

按：编程规范是程序员在实践中，为维护代码，便于集体开发，制定的一种约定，也是程序开发经验总结。你可以参考、制定自己的规范，但不可拘泥。 " I* W; v% L5 H9 }* ]+ k 1 W6 U: z# S% d5 S _在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.net编码规范，是一种被证明能明显改善代码可读性，并有助于代码管理、分类的编码规范。采用这种编码规范，能避免如匈牙利命名法带来的繁长前缀，便于记忆变量的用途。下面的介绍这种编码规范。 ' t5 c4 ?2 @, ~9 Z2 e2 [% w1 T" M 一、类型级单位的命名 1、类。 9 M+ g; c+ |! Q以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如： Class Indicator 1 |5 X* h- n w, L . i/ R* b" ^! P0 c" v0 g当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾： Class ColorSetException " O% ?: k- v6 A3 `* [8 l* TClass CauseExceptionAttribute 当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如 9 G) E K( _7 j4 Q: JClass ScreenClass # z7 D3 e1 p$ I7 Q8 `/ WClass SystemClass 2 @. [" @% j; V2 R, d当类只用于作为其他类的基类，根据情况，以Base结尾： $ P/ n7 o1 L, ~8 T0 @2 t UMustInherit Class IndicatorBase / g% Z* ^( {( |* c2 a如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page： 7 y# ?$ c, T2 N. e- p. BClass PrintForm : Inherits Form ‘* Windows窗体 0 {4 o" O3 ]' dClass StartPage : Inherits Page ‘* Web窗体 7 [6 J8 x, J# X 2、枚举和结构 $ ~) [2 U7 k- Z g6 I. u2 Z# P 同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如： Enum ColorButtons ‘以复数结尾，表明这是一个枚举 ( X9 \4 @) l5 q1 Y# d2 @* y6 J/ G8 B7 r+ mStructure CustomerInfoRecord ‘以Record结尾，表明这是一个结构体 3、委派类型 ' C- M |' s' U, [* L普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能： Delegate Sub DataSeeker (ByVal SeekString As String) # k0 Z5 g ^& K# \用于事件处理的委派类型，必须以EventHandler结尾，如： Delegate Sub DataChangedEventHandler (ByVal Sender As Object, ByVal e As DataChangedEventArgs) 4 v2 o4 O9 v8 S" L, B' c0 F4 Y4、接口 与其他类型不同，接口必须要由I作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力： Interface ISortable 5 s$ w9 {+ H! p1 { R x0 X5、模块 模块不是类型，他的名称除了必须以名词命名外，必须加以后缀Module: Module SharedFunctionsModule q8 Y) |& E$ M$ n' M8 ]上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 . B, { q/ [- Z) v: O) C 二、方法和属性的命名 7 `/ y, }9 n) V ) U+ m6 s8 A( v5 [' O1、方法 无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。 1 v) m% |! s6 |9 Q5 R1 d- y6 Z B+ h2 L" [Sub Open(ByVal CommandString As String) ) Y( y- r/ x# aFunction SetCopyNumber(ByVal CopyNumber As Integer) , S9 K4 V% D3 o) \7 i2 K# s6 F参数需要指明ByVal还是ByRef，这一点写起来会让程序边长，但非常必要。如果没有特别情况，都使用ByVal。参数的命名方法，参考后面“变量的命名方法”。需要重载的方法，一般不写Overloads，根据需要编写重载的方法。 % b* Q: v4 P- f( Z % f. h; V7 ~* @% W: m t2、属性 原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名： Property Concentration As Single 8 X! X, X1 n( F2 ~; o, a5 g; @Property Customer As CustomerTypes [2 L, P% y7 A# Z2 z * s0 Z7 p1 j! }& ~: D3、事件 5 v- S* P: [$ L! D! H) K事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间： Event Click As ClickEventHandler Event ColorChanged As ColorChangedEventHangler ) N$ j' a9 I4 i8 q 三、变量和常数 + H3 O6 d/ b! Q* ?& f - ~; Z1 j1 }1 L, Y: q常数以表明常数意义的名词命名，一般不区分常数的类型： , W4 s7 p) l: U2 Z! JConst DefaultConcentration As Single = 0.01 在严格要求的代码中，常数以c_开头，如c_DefaultConcentration，但最好不要用它，它会带来输入困难。 普通类型的变量，只要用有意义的名字命名即可，不可使用简称和无意义的名称诸如A，x1等，下面给出了良好的例子： ! Z; ]. y3 S p( t. o V- hDim Index As Integer Dim NextMonthExpenditure As Decimal Dim CustomerName As String ; P' Z& ~% v+ G9 p2 J" D不能起太长的名字，应该尽量简洁，如下面的例子： Dim VariableUsedToStoreSystemInformation As String ‘* 错误，太复杂了 * s% L( d' G$ f+ w' D+ ADim SystemInformation As String ‘* 正确，简单明了 Dim sysInfo As String ‘* 错误，过于简单 - |2 Y Z" [; B5 d9 ?8 z特殊情况可以考虑一个字母的变量： Dim g As Graphic * v3 U; i ~# T% Z) O! {/ f对于控件，应该指明控件的类型，方法是直接在变量后面加以类名： Friend WithEvents NextPageButton As Button ‘* 按钮 6 S6 p4 p3 N; q: p4 HFriend WithEvents ColorChoicerPanel As Panel ‘* 面版 3 P; a' {0 w0 w' L( ^' Q" g" sFriend WithEvents CardFileOpenDialog As FileOpenDialog ‘* 文件打开对话框 4 @7 j/ h4 N* e! o等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码： ! A- R+ \: f1 a% v# `! AbtnCancel.Text = "&Cancel" CancelButton.Text = "&Cancel" 显然后者更能使阅读者明白变量的类型是一个按钮。 四、标签 / y# h+ i ^& q, I1 Y1 g' |: Z # r- _ {7 c- S% Y) x3 S标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如： 6 F& x% h* u! G_A_LABEL_EXAMPLE: 如此定义标签是为了与其他代码元素充分区别。 + ?5 H' R9 J: o2 }% m1 W! A ; r- m. I, ~% W! V7 A% S五、名字空间 通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是： + f! z( x. ^' P1 s$ n4 I! d2 e公司名.产品名[.组件名的复数] 如： 0 L/ u5 \4 D. m2 u6 cNamespace Ninputer.VirtualScreen Namespace Ninputer.CardEditor.CustomeControls 随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。 4 W( Q& k1 s3 A& z# {- q- _3 f六、注释 注释的规则繁多，这里仅提到其中一点：正常的注释以‘*开头，单独的‘只用来注释暂时不用的代码 ‘* 这是普通的注释 ! J9 _! i/ `' t# f" [( K5 i‘* 这段代码在调试正确后加入 ‘If UseHighSpeed(g) = True Then .... * V* N0 i i( u这样能够方便的采用代码注释工具控制代码的使用。 以上已经简单的介绍了我使用的VB.net代码规范，这个代码规范也适用于C#。仅供大家参考。