使用.net已经很久了,不断地的编写着各种各样的小工具,但是每次回看自己的写的代码或者想要复用以前的代码时总是面临着一些麻烦,那就是命名规则的不统一,导致阅读时理解代码需要花费很长时间,或者是复用代码时总是要再次修改各种类、模块、变量的命名,不仅麻烦而且还容易出现错误。于是想要写下这篇文章用来规范命名的规则,虽然这些规则不是教科书中的那种方式,但是毕竟是在实践中摸索出来的,总归是能够便于阅读和复用的。
- 命名空间:关键字是NameSpace,命名规则建议为"ns"+名称,例如:
Namespace nsArticle
'这里的名称为单个英文单词,首字母大写
End Namespace
Namespace nsMessageQueue
'这里的名称为两个英文单词,每个英文单词首字母大写
End Namespace
Namespace nsAPI
'这里的名称为英文缩写,每个字母都大写
End Namespace
- 类(变量、属性、函数、过程等):关键字是Class,针对这种包含内容丰富且包含实现一类操作的整体,建议命名规则为"cs"+名称,例如:
Public Class csDebug
'这里的名称为单个英文单词,首字母大写
End Class
Public Class csMessageQueue
'这里的名称为两个英文单词,每个英文单词首字母大写
End Class
Public Class csAPI
'这里的名称为英文缩写,每个字母都大写
End Class
- 类(仅为结构体):关键字是Class,结构体原来在VB当中使用的关键字是Structure,在.net中完全可以使用Class代替,而且效果更好。建议命名规则为"st"+名称,例如:
Public Class stResult
'这里的名称为单个英文单词,首字母大写
End Class
Public Class stTextMessage
'这里的名称为两个英文单词,每个英文单词首字母大写
End Class
Public Class stUI
'这里的名称为英文缩写,每个字母都大写
End Class
- 实例化类:在对一个类进行实例化时,建议命名规则为"it"+名称,例如:
Public Sub Run()
Dim itDebug As New csDebug()
'这里的名称为单个英文单词,首字母大写
Dim itMessageQueue As New csMessageQueue()
'这里的名称为两个英文单词,每个英文单词首字母大写
Dim itAPI As New csAPI()
'这里的名称为英文缩写,每个字母都大写
End Sub