C#编码规范

一、类型级单位的命名

1、类。

以class声明的类，都必须以名词或名词短语命名，体现类的作用。如：

class indicator

当类是一个特性（attribute）时，以attribute结尾，当类是一个异常（exception）时，以exception结尾：

class colorsetexception

class causeexceptionattribute

当类只需有一个对象实例（全局对象，比如application等），必须以class结尾，如

class screenclass

class systemclass

当类只用于作为其他类的基类，根据情况，以base结尾：

mustinherit class indicatorbase

如果定义的类是一个窗体，那么名字的后面必须加后缀form，如果是web窗体，必须加后缀page：

class printform : inherits form * windows窗体

class startpage : inherits page * web窗体

2、枚举和结构

同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如：

enum colorbuttons 以复数结尾，表明这是一个枚举

structure customerinforecord 以record结尾，表明这是一个结构体

3、委派类型

普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能：

delegate sub dataseeker (byval seekstring as string)

用于事件处理的委派类型，必须以eventhandler结尾，如：

delegate sub datachangedeventhandler (byval sender as object, byval e as datachangedeventargs)

4、接口

与其他类型不同，接口必须要由i作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力：

interface isortable

5、模块

模块不是类型，他的名称除了必须以名词命名外，必须加以后缀module:

module sharedfunctionsmodule

上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。

二、方法和属性的命名

1、方法

无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。

sub open(byval commandstring as string)

function setcopynumber(byval copynumber as integer)

参数需要指明byval还是byref，这一点写起来会让程序边长，但非常必要。如果没有特别情况，都使用byval。参数的命名方法，参考后面“变量的命名方法”。需要重载的方法，一般不写overloads，根据需要编写重载的方法。

2、属性

原则上，字段（field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名：

property concentration as single

property customer as customertypes

3、事件

事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间：

event click as clickeventhandler

event colorchanged as colorchangedeventhangler

三、变量和常数

常数以表明常数意义的名词命名，一般不区分常数的类型：

const defaultconcentration as single = 0.01

在严格要求的代码中，常数以c_开头，如c_defaultconcentration，但最好不要用它，它会带来输入困难。

普通类型的变量，只要用有意义的名字命名即可，不可使用简称和无意义的名称诸如a，x1等，下面给出了良好的例子：

dim index as integer

dim nextmonthexpenditure as decimal

dim customername as string

不能起太长的名字，应该尽量简洁，如下面的例子：

dim variableusedtostoresysteminformation as string * 错误，太复杂了

dim systeminformation as string * 正确，简单明了

dim sysinfo as string * 错误，过于简单

特殊情况可以考虑一个字母的变量：

dim g as graphic

对于控件，应该指明控件的类型，方法是直接在变量后面加以类名：

friend withevents 下一页：不该用generics实现abstract factory的理由 button as button * 按钮

friend withevents colorchoicerpanel as panel * 面版

friend withevents cardfileopendialog as fileopendialog * 文件打开对话框

等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码：

btncancel.text = "&cancel"

cancelbutton.text = "&cancel"

显然后者更能使阅读者明白变量的类型是一个按钮。

四、标签

标签就是用于goto跳转的代码标识，由于goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如：

_a_label_example:

如此定义标签是为了与其他代码元素充分区别。

五、名字空间

通常，一个工程使用一个名字空间，通常不需要用namespace语句，而是在工程选项的“root namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是vb十足的优点。名字空间的语法是：

公司名.产品名[.组件名的复数]

如：

namespace ninputer.virtualscreen

namespace ninputer.cardeditor.customecontrols

随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。

六、注释

注释的规则繁多，这里仅提到其中一点：正常的注释以 *开头，单独的 只用来注释暂时不用的代码

* 这是普通的注释

* 这段代码在调试正确后加入

if usehighspeed(g) = true then ....