求VB.NET的命名規則。。3Q。

[mingzong]

哪個大哥有關於這個方面的資料給我貼下
3Q

[bvtc_liguoyuan]

类命名
在为类（class ）命名前首先要知道它是什么。如果通过类名的提供的线索，你还是想不起这个类是
什么 的话，那么你的设计就还做的不够好。


超过三个词组成的混合名是容易造成系统各个实体间的混淆，再看看你的设计，尝试使用（CRC Se-
ssion card)看看该命名所对应的实体是否有着那么多的功用。


对于派生类的命名应该避免带其父类名的诱惑，一个类的名字只与它自身有关，和它的父类叫什么无
关。


有时后缀名是有用的，例如：如果你的系统使用了代理（agent ），那么就把某个部件命名为“下
载代理”（DownloadAgent）用以真正的传送信息。
方法和函数命名
通常每个方法和函数都是执行一个动作的，所以对它们的命名应该清楚的说明它们是做什么的：用
CheckForErrors()代替ErrorCheck()，用DumpDataToFile()代替DataFile()。这么做也可以使功能和
数据成为更可区分的物体。


有时后缀名是有用的:
Max - 含义为某实体所能赋予的最大值。
Cnt - 一个运行中的计数变量的当前值。
Key - 键值。
例如：RetryMax 表示最多重试次数，RetryCnt 表示当前重试次数。


有时前缀名是有用的：
Is - 含义为问一个关于某样事物的问题。无论何时，当人们看到Is就会知道这是一个问题。
Get - 含义为取得一个数值。
Set - 含义为设定一个数值
例如：IsHitRetryLimit。



缩写词不要全部使用大写字母
无论如何，当遇到以下情况，你可以用首字母大写其余字母小写来代替全部使用大写字母的方法来表
示缩写词。

使用: GetHTMLStatistic.
不使用: GetHTMLStatistic.

理由
当命名含有缩略词时，人们似乎有着非常不同的直觉。统一规定是最好，这样一来，命名的含义就完
全可以预知了。
举个NetworkABCKey的例子，注意C是应该是ABC里面的C还是key里面的C，这个是很令人费解的。有些
人不在意这些，其他人却很讨厌这样。所以你会在不同的代码里看到不同的规则，使得你不知道怎么
去叫它。

例如
class FluidOz // 不要写成 FluidOZ
class GetHTMLStatistic // 不要写成 GetHTMLStatistic



--------------------------------------------------------------------------------

类命名
使用大写字母作为词的分隔，其他的字母均使用小写
名字的首字母使用大写
不要使用下划线('_')
理由
根据很多的命名方式，大部分人认为这样是最好的方式。
例如
class NameOneTwo

class Name



--------------------------------------------------------------------------------

类库命名
目前命名空间正在越来越广泛的被采用，以避免不同厂商和团体类库间的类名冲突。


当尚未采用命名空间的时候，为了避免类名冲突，一般的做法是在类名前加上独特的前缀，两个字符就
可以了，当然多用一些会更好。
例如
John Johnson的数据结构类库可以用Jj做为前缀，如下：
class JjLinkList
{
}



--------------------------------------------------------------------------------

方法命名
采用与类命名一致的规则
理由
使用所有不同规则的大部分人发现这是最好的折衷办法。
例如
class NameOneTwo
{
function DoIt() {};
function HandleError() {};
}



--------------------------------------------------------------------------------

类属性命名
属性命名应该以字符‘m’为前缀。
前缀‘m’后采用于类命名一致的规则。
‘m’总是在名字的开头起修饰作用，就像以‘r’开头表示引用一样。
理由
前缀'm'防止类属性和方法名发生任何冲突。你的方法名和属性名经常会很类似，特别是存取元素。
例如
class NameOneTwo
{
function VarAbc() {};
function ErrorNumber() {};
var mVarAbc;
var mErrorNumber;
var mrName;
}



--------------------------------------------------------------------------------

方法中参数命名
第一个字符使用小写字母。
在首字符后的所有字都按照类命名规则首字符大写。
理由
你可以随时知道那个变量对应那个变量。
你可以使用与类名相似的名称而不至于产生重名冲突。
例如
class NameOneTwo
{
function StartYourEngines(
&$rSomeEngine,
&$rAnotherEngine);
}



--------------------------------------------------------------------------------

变量命名
所有字母都使用小写
使用'_'作为每个词的分界。
理由
通过这一途径，代码中变量的作用域是清晰的。
所有的变量在代码中都看起来不同，容易辨认。
例如
function HandleError($errorNumber)
{
$error = OsErr();
$time_of_error = OsErr->getTimeOfError;
$error_processor = OsErr->getErrorProcessor;
}



--------------------------------------------------------------------------------

引用变量和函数返回引用
引用必须带‘r’前缀
理由
使得类型不同的变量容易辨认
它可以确定哪个方法返回可更改对象，哪个方法返回不可更改对象。
例如
class Test
{
var mrStatus;
function DoSomething(&$rStatus) {};
function &rStatus() {};
}



--------------------------------------------------------------------------------

全局变量
全局变量应该带前缀‘g’。
理由
知道一个变量的作用域是非常重要的。
例如
global $gLog;
global &$grLog;



--------------------------------------------------------------------------------

定义命名 / 全局常量
全局常量用'_'分隔每个单词。
理由
这是命名全局常量的传统。你要注意不要与其它的定义相冲突。
例如
define("A_GLOBAL_CONSTANT", "Hello world!";


--------------------------------------------------------------------------------

静态变量
静态变量应该带前缀‘s’。
理由
知道一个变量的作用域是非常重要的。
例如
function test(){ static $msStatus = 0;
}



--------------------------------------------------------------------------------

函数命名
函数名字采用C GNU的惯例，所有的字母使用小写字母，使用'_'分割单词。
理由
这样可以更易于区分相关联的类名。
例如
function some_bloody_function()
{
}



--------------------------------------------------------------------------------

错误返回检测规则
检查所有的系统调用的错误信息，除非你要忽略错误。
为每条系统错误消息定义好系统错误文本以便include。


--------------------------------------------------------------------------------

大括号 {} 规则
在三种主要的大括号放置规则中，有两种是可以接受的，如下的第一种是最好的：
将大括号放置在关键词下方的同列处：
if ($condition) while ($condition)
{ {
... ...
} }

传统的UNIX的括号规则是，首括号与关键词同行，尾括号与关键字同列：
if ($condition) { while ($condition) {
... ...
} }

理由
引起剧烈争论的非原则的问题可通过折衷的办法解决，两种方法任意一种都是可以接受的，然而对于大
多数人来说更喜欢第一种。原因就是心理研究学习范畴的东西了。
对于更喜欢第一种还有着更多的原因。如果您使用的字符编辑器支持括号匹配功能的话（例如vi），最
重要的就是有一个好的样式。为什么？我们说当你有一大块的程序而且想知道这一大块程序是在哪儿结
束的话。你先移到开始的括号，按下按钮编辑器就会找到与之对应的结束括号，例如：

if ($very_long_condition && $second_very_long_condition)
{
...
}
else if (...)
{
...
}

从一个程序块移动到另一个程序块只需要用光标和你的括号匹配键就可以了，不需要来回的移动到行末去
找匹配的括号。

[liangfengxx]

VB.NET/ASP.NET编码规范
在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.NET/ASP.NET编码规范，是一种被证明能明显改善代码可读性，并有助于代码管理、分类的编码规范。采用这种编码规范，能避免如匈牙利命名法带来的繁长前缀，便于记忆变量的用途。下面的介绍这种编码规范。


一、类型级单位的命名
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 NextPageButton As Button ''* 按钮
Friend WithEvents ColorChoicerPanel As Panel ''* 面版
Friend WithEvents CardFileOpenDialog As FileOpenDialog ''* 文件打开对话框
等等，无需规定某种类型的变量的前缀，只需把类型写在后面就行了，试对比下列代码：
btnCancel.Text = &Cancel
CancelButton.Text = &Cancel
显然后者更能使阅读者明白变量的类型是一个按钮。




四、前缀

1、 对象
1)标准对象
名称 前缀 例子 说明
System.Array arr arrUsers 用户集合
System.Boolean bln blnDoesUserExist 用户是否存在
System.Byte byt bytStreamContent 字节流内容
System.Char chr chrKeyPress 按键
System.DateTime dte dteCreatedDateTime 创建日期
System.Decimal dec decYearlySaleQuota 年度销售额
System.Double dbl dblTotalPrice 总金额
System.Interger int intMessages 消息数
System.Object obj objExternalFunction 外部功能
System.Single sng sngFinishRate 完成率
System.String str strLoginName 登陆名称
System.Exception exc excRet 错误
System.Enum enm enmUserStates 用户状态
Structure stu stuEmployees 员工类型
System.Data.SqlClient.SqlConnection cnn cnnDatabase 数据库连接
System.Data.SqlClient.SqlCommand cmm cmmUserAddUpdate 用户添加更新
System.Data.SqlClient.SqlDataAdapter sda sdaUsers 用户数据适配器
System.Data.SqlClient.SqlDataReader sdr sdrUserData 用户数据读取器


2)自定义对象
我们规定应该根据自定义对象的名称来确定该对象类型的前缀，例子如下:
对象：SysSet
前缀：ss
例子：ssSafety


2、根据变量与常量的生存周期，我们应该定义不同的生存周期前缀以示区别，以便我们清楚该变量/常量的范围。
a) 类、模块、组件、控件
我们规定在类、模块、组件、控件范围内，变量的生存周期前缀应该添加“m_”(Module－模块)。例子如下：
名称 前缀 例子 说明
System.Array m_arr m_arrUsers 用户集合
System.Boolean m_bln m_blnDoesUserExist 用户是否存在
System.Byte m_byt m_bytStreamContent 字节流内容
System.Char m_chr m_chrKeyPress 按键
System.DateTime m_dte m_dteCreatedDateTime 创建日期
System.Decimal m_dec m_decYearlySaleQuota 年度销售额
System.Double m_dbl m_dblTotalPrice 总金额
System.Interger m_int m_intMessages 消息数
System.Object m_obj m_objExternalFunction 外部功能
System.Single m_sng m_sngFinishRate 完成率
System.String m_str m_strLoginName 登陆名称
System.Exception m_exc m_excRet 错误
System.Enum m_enm m_enmUserStates 用户状态
Structure m_stu m_stuEmployees 员工类型
System.Data.SqlClient.SqlConnection m_cnn m_cnnDatabase 数据库连接
System.Data.SqlClient.SqlCommand m_cmm m_cmmUserAddUpdate 用户添加更新
System.Data.SqlClient.SqlDataAdapter m_sda m_sdaUsers 用户数据适配器
System.Data.SqlClient.SqlDataReader m_sdr m_sdrUserData 用户数据读取器



b) 过程、函数、属性、事件
我们规定在过程、函数、属性、事件范围内，变量的生存周期前缀应该添加“o_”(Owner－私有)。例子如下：
名称 前缀 例子 说明
System.Array o_arr o_arrUsers 用户集合
System.Boolean o_bln o_blnDoesUserExist 用户是否存在
System.Byte o_byt o_bytStreamContent 字节流内容
System.Char o_chr o_chrKeyPress 按键
System.DateTime o_dte o_dteCreatedDateTime 创建日期
System.Decimal o_dec o_decYearlySaleQuota 年度销售额
System.Double o_dbl o_dblTotalPrice 总金额
System.Interger o_int o_intMessages 消息数
System.Object o_obj o_objExternalFunction 外部功能
System.Single o_sng o_sngFinishRate 完成率
System.String o_str o_strLoginName 登陆名称
System.Exception o_exc o_excRet 错误
System.Enum o_enm o_enmUserStates 用户状态
Structure o_stu o_stuEmployees 员工类型
System.Data.SqlClient.SqlConnection o_cnn o_cnnDatabase 数据库连接
System.Data.SqlClient.SqlCommand o_cmm o_cmmUserAddUpdate 用户添加更新
System.Data.SqlClient.SqlDataAdapter o_sda o_sdaUsers 用户数据适配器
System.Data.SqlClient.SqlDataReader o_sdr o_sdrUserData 用户数据读取器

[liangfengxx]

五、标签
标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如：
_A_LABEL_EXAMPLE:
如此定义标签是为了与其他代码元素充分区别。


六、名字空间
通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是：
公司名.产品名[.组件名的复数]
如：
Namespace COM.NET
Namespace COM.File.IO.Files
随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。

七、格式化
良好的格式化代码对我们的浏览与维护有相当的好处。
1、 块
.NET提供了#Region...#End Region块控制。我们应该根据代码所实现的功能分类并以块组织起来。
2、 缩进
每个层次直接都应该以Tab进行缩进，而不是Space(空格键)。

3、 流
每个方法、函数、属性、事件应该有且只有一个入口和一个出口。如果遇见多层嵌套而需要直接跳出的时候，请使用局部Boolean或者Integer变量来标示用以多层跳出。
譬如：
Private Function TestForReturn () As Boolean
Dim o_blnRet As Boolean=False
Dim i As Integer, l As Integer
For i=1 To 100
For l=1 To 10
If (x) Then
o_blnRet=True
Exit For
Else
End If
Next
If o_blnRet Then
Exit For
Else
End If
Next
Return o_blnRet ''这里是唯一出口
End Function


八、注释
1、 准则
注释的规则繁多，基本地：正常的注释以''*开头，单独的''只用来注释暂时不用的代码
''* 这是普通的注释
''* 这段代码在调试正确后加入
''If UseHighSpeed(i) = True Then ....
这样能够方便的采用代码注释工具控制代码的使用。
2、类（包括WebForm、WinForm等）、模块、组件、控件
每个类、模块、组件、控件最开始的地方必须输入该对象的信息，样例内容与格式如下：
''******************************************************************
''*
''* 对象名称：OnlineUpdateService
''* 命名空间： http://www.domain.cn/onlineupdate/OnlineUpdateService.asmx
''* 作 者：chs(Wilson Chan)
''* 功能说明：在线更新Web Services
''* 创建日期：2003/07/27
''* 修改日期：2003/09/5 16:59
''* 修改记录：
''* •2003/07/31
''* 1.AddUpdateUserCategory/DeleteUserCategory
''* 2.AddUpdateUserState/DeleteUserState
''* 3.AddUpdateServerUpdate/DeleteServerUpdate
''* 4.AddUpdateClientUpdate/DeleteClientUpdate
''* 5.AddUpdateClientUpdateLog/DeleteClientUpdateLog
''* 6.GetServerUpdates/GetClientUpdates/GetClientUpdateLogs
''*
''******************************************************************
一般地，我们要求内容有：对象名称、命名空间、作者、功能说明、创建日期、修改日期、修改记录，特别地，我们要求修改记录应该详细叙述最近的修改。
3、方法、函数、事件与属性
每个方法、函数、事件与属性最开始的地方必须输入该对象的信息，样例内容与格式如下：
''*名称：OnlineUpdateFileAddUpdate
''*功能：添加更改更新信息
''*作者：chs
''*创建：2003/7/31
''*修改：2003/7/31
''*参数：intID：唯一标示
''* strTitle：标题
''* strVersion：版本
''* strVerifier：标示
''* strDescription：描述
''* strRelatedFile：相关文件
''* strUpdatePackage：下载包
''* intState：状态
''* dteCreatedDateTime：创建日期
''*返回：成功，True，反之，False
''*说明：
一般地，我们要求内容有：名称、功能、作者、说明、创建、修改、参数与返回。

九、完整性
1、If...Else...End If
2、Select Case...Case Else...End Select
十、安全性
1、Try...Catch...Finally...End Try
十一、优化
1、With
2、For...Next
3、Do Until...Loop
4、代码重构