VB.net编码规范(转帖)

踏浪行歌

按：编程规范是程序员在实践中，为维护代码，便于集体开发，制定的一种约定，也是程序开发经验总结。你可以参考、制定自己的规范，但不可拘泥。 , T+ r; r4 ]9 r/ S0 J) Q. V在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.net编码规范，是一种被证明能明显改善代码可读性，并有助于代码管理、分类的编码规范。采用这种编码规范，能避免如匈牙利命名法带来的繁长前缀，便于记忆变量的用途。下面的介绍这种编码规范。 7 \; U8 Z& A2 Y& q一、类型级单位的命名 1、类。 以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如： 9 Z; M) g+ _' F* A: k$ HClass Indicator - m ^- S% V/ G- F, G) P & c( s& b ]0 H, D7 J当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾： Class ColorSetException 7 \7 m: ^' i$ q# G" ?' L% s8 b' r7 LClass CauseExceptionAttribute & |6 V! y3 z2 W* ^9 T/ O当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如 Class ScreenClass ) Y& x! ^1 {1 h. g& ]9 U% q, uClass SystemClass 当类只用于作为其他类的基类，根据情况，以Base结尾： * }, v. h$ y2 VMustInherit Class IndicatorBase 1 m" Y) U; M/ Q如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page： Class PrintForm : Inherits Form ‘* Windows窗体 ! h" g' I' u0 V! O( WClass StartPage : Inherits Page ‘* Web窗体 9 {' u, r* S6 u8 V; b 2、枚举和结构 , k3 V. E! n/ e$ ~- @同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如： Enum ColorButtons ‘以复数结尾，表明这是一个枚举 Structure CustomerInfoRecord ‘以Record结尾，表明这是一个结构体 , l/ w5 Q3 p j. s6 [: `+ @8 F3、委派类型 : U# p+ k& L# U2 a1 ?5 J普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能： Delegate Sub DataSeeker (ByVal SeekString As String) 用于事件处理的委派类型，必须以EventHandler结尾，如： Delegate Sub DataChangedEventHandler (ByVal Sender As Object, ByVal e As DataChangedEventArgs) 4、接口 与其他类型不同，接口必须要由I作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力： Interface ISortable 3 b7 k. E# ^/ m1 m4 m2 W2 X5、模块 模块不是类型，他的名称除了必须以名词命名外，必须加以后缀Module: Module SharedFunctionsModule * X. b3 n: w. L$ G8 B" P上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 0 P& `. C9 H: D; ^$ Q2 |' K9 i二、方法和属性的命名 8 u! v) l- d% q1 k/ Z4 F! a1、方法 无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。 Sub Open(ByVal CommandString As String) Function SetCopyNumber(ByVal CopyNumber As Integer) % z9 H% q9 ~ Z4 S/ O! C参数需要指明ByVal还是ByRef，这一点写起来会让程序边长，但非常必要。如果没有特别情况，都使用ByVal。参数的命名方法，参考后面“变量的命名方法”。需要重载的方法，一般不写Overloads，根据需要编写重载的方法。 4 o8 r( y- A1 `( P - l. r! }8 H: Y: |$ [+ d2、属性 , w% `0 d+ K' J: x/ j/ P原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名： Property Concentration As Single Property Customer As CustomerTypes ; d7 r2 q5 \8 a9 m: G 3、事件 事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间： , j* F3 w% r4 c' x3 @Event Click As ClickEventHandler Event ColorChanged As ColorChangedEventHangler : S8 R+ E* B6 x三、变量和常数 . t' ~1 V6 o7 Z- e3 R9 y# x 常数以表明常数意义的名词命名，一般不区分常数的类型： Const DefaultConcentration As Single = 0.01 # S5 e! n5 P8 J5 K! Z8 ]在严格要求的代码中，常数以c_开头，如c_DefaultConcentration，但最好不要用它，它会带来输入困难。 " L, n# y' }# C7 P普通类型的变量，只要用有意义的名字命名即可，不可使用简称和无意义的名称诸如A，x1等，下面给出了良好的例子： Dim Index As Integer - b' `8 |1 b$ a8 U) |Dim NextMonthExpenditure As Decimal Dim CustomerName As String 9 |1 g7 I4 x( T- z* `2 Q不能起太长的名字，应该尽量简洁，如下面的例子： Dim VariableUsedToStoreSystemInformation As String ‘* 错误，太复杂了 Dim SystemInformation As String ‘* 正确，简单明了 1 c: e; R' l, q% o% P5 WDim sysInfo As String ‘* 错误，过于简单 特殊情况可以考虑一个字母的变量： Dim g As Graphic 0 r8 Z: ^2 x& L3 ^6 I* h对于控件，应该指明控件的类型，方法是直接在变量后面加以类名： Friend WithEvents NextPageButton As Button ‘* 按钮 Friend WithEvents ColorChoicerPanel As Panel ‘* 面版 Friend WithEvents CardFileOpenDialog As FileOpenDialog ‘* 文件打开对话框 5 L4 ^7 u' V1 L" s% s0 U: {等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码： 7 Z- }4 T3 I: B7 ~5 t) M; `! lbtnCancel.Text = "&Cancel" CancelButton.Text = "&Cancel" 显然后者更能使阅读者明白变量的类型是一个按钮。 6 l$ C( Z8 d, I$ t + \+ M3 B* s! f0 A1 Z0 R5 z- b四、标签 % G) i z7 t9 d8 n7 p, h( g ! a3 v! x3 L. h+ J, {; R* Y标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如： _A_LABEL_EXAMPLE: 3 Y; a2 @ Y2 \; o& v; L如此定义标签是为了与其他代码元素充分区别。 - t% }1 N' O0 B4 a 五、名字空间 % _9 ]' L2 R# y " _+ T5 f( d$ `, ^6 T通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是： 8 R" V/ F+ r( x2 c) r公司名.产品名[.组件名的复数] " ^1 d/ g/ y0 s9 D# U U% o; p2 `, Y2 d如： ! A5 r g7 u! l5 |) [9 `" m+ `Namespace Ninputer.VirtualScreen Namespace Ninputer.CardEditor.CustomeControls 9 c7 v. F& g8 \! B随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。 & b- ?) o. s/ L! Z. V 7 g/ p. d* r7 o/ @ }+ E8 ?六、注释 % v6 e0 ?( ]' }2 Q注释的规则繁多，这里仅提到其中一点：正常的注释以‘*开头，单独的‘只用来注释暂时不用的代码 0 x. D" `; V( ~6 {; B‘* 这是普通的注释 " K) p* p0 P# {3 h% o. z6 p‘* 这段代码在调试正确后加入 ‘If UseHighSpeed(g) = True Then .... 这样能够方便的采用代码注释工具控制代码的使用。 " J0 j! [0 w3 F4 `% \, v6 i以上已经简单的介绍了我使用的VB.net代码规范，这个代码规范也适用于C#。仅供大家参考。