.NET 命名规范

VS.NET 2003命名规范

遵从以下良好的习惯以写出好程序
 避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
 避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
 方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。
注记 :
Pascal： 大小写形式－所有单词第一个字母大写，其他字母小写。（MyTable）
Camel ： 大小写形式－除了第一个单词，所有单词第一个字母大写，其他字母小写。(myTable)
1．类名使用Pascal 大小写形式
public class HelloWorld{ ...}
以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如：
Class Indicator
当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾：
Class ColorSetException
Class CauseExceptionAttribute
2．方法使用Pascal 大小写形式
无论是函数还是子程序，方法都必须以动词或动词短语命名。无需区分函数和子程序，也无需指明返回类型。
public class HelloWorld{ void SayHello(string name) { ... }}
3．变量和方法参数使用Camel 大小写形式
Int age,string name,string myName
4．不要使用匈牙利方法来命名变量
String m_sName
这种方式在.NET编码规范中是不推荐的。所有变量都用Camel 大小写形式，而不是用数据类型和m_ 来作前缀。
5. 属性使用Pascal大小写形式
在面向对象的语言中，在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用
Book.Title,KingDown
6．枚举和结构
同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如：
Enum ColorButtons '以复数结尾，表明这是一个枚举
Structure CustomerInfoRecord '以Record结尾，表明这是一个结构体
7．接口
与其他类型不同，接口必须要由I作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力：
Interface ISortable
8．代码书写规范
格式化使代码的逻辑结构很明显。确保源代码以一致的逻辑方式进行格式化，这对于开发小组，以及以后维护源代码的其他开发人员都有很大的帮助。
缩进大小（四个空格/Tab键）
for (i = 0; i < 100; i++) //示列1
{
//此处填写代码块；
}
if(expression )// 示列2
{
if(expression )
{
//此处填写代码块;
}
else
{
//此处填写你的代码块;
}
}
SQL语句 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句
SELECT FirstName, LastName
FROM Customers
WHERE State = 'WA'
9．注释
• 别每行代码，每个声明的变量都做注释。
• 在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。
• 行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。
• 如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。
• 对一个数值变量采用不是0,-1等的数值初始化，给出选择该值的理由。
• 简言之，要写清晰，可读的代码以致无须什么注释就能理解。
• 对注释做拼写检查，保证语法和标点符号的正确使用