在以前版本的Visual Studio中,微软曾建议使用匈牙利命名法来写代码.在最近发布的.NET和它的编程语言中,微软更换了他的这一法则.
1. 对格式与方法名称使用PASCAL风格[1]
public class SomeClass
{
public SomeMethod(){}
}
2. 对局部变量和方法参数使用Camel风格[2]
int number;
void MyMethod(int someNumber)
{}
3. 使用I作为接口前缀
interface IMyInterface
{..}
4. 使用m_作为私有成员变量前缀
public class SomeClass
{
private int m_Number;
}
5. 使用Attribute作为自定义属性类的后缀
6. 使用Exception作为自定义异常处理类的后缀
7. 使用动词形式命名方法名,如ShowDialog()
8. 带有返回值的方法应该有一个方法来描述返回值,如GetObjectStatus()
9. 使用易描述的变量名称
l 避免使用单一字符描述变量名称,如i或t.应使用index或temp替代
l 对共有以及受保护成员避免使用匈牙利命名法则[3]
l 绝不使用缩写字符,如使用num代替number
10. 总是使用C#预定义格式,而不使用在System空间内的别名
object NOT 0bject
string NOT String
int NOT Int32
11. 一般的,对于格式使用大写字母,当处理.NET格式Type时使用Type后缀
//Correct:
public class LinkedList<K, T>
{..}
//Avoid:
public class LinkedList<KeyType,DataType>
{..}
12. 使用易理解的命名空间[4]名称,如产品或公司名称
13. 避免使用命名空间的完整限定名称,应使用using声明替代
14. 避免using声明放置在命名空间内部
15. 将所有的框架命名空间分组,将用户或第三方命名空间放置在其下
using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using MyCompany;
using MyControls;
16. 使用委托引用[5]代替显式的委托实例
delegate void SomeDelegate();
public void SomeMethod()
{..}
SomeDelegate someDelegate=SomeMethod;
17. 保持严格的缩进
l 对缩进使用3个空格位
l 绝不使用TAB或者不标准的缩进,如1,2或4个空格位
18. 将注释缩拍在与代码缩进同等级的位置上
19. 所有的注释应该通过拼写检查.拼错的注释将预示冗余的开发
20. 所有的成员变量应该在开始就被声明,并使用单独一行将属性与方法区域分开
public class MyClass
{
int m_Number;
string m_Name;
public void SomeMethodl()
{}
public void SomeMethod2()
{}
}
21. 在离第一次使用变量尽可能近的地方声明该局部变量
22. 文件名称应反映出其包含的类
23. 当使用partial类[6]并将其分配给每个文件一部分时,对每个文件命名使用后缀P并附带一个额外的数字
//In MyClassP1.cs
public partial class MyClass
{..}
// In MyClassP2.cs
public partial class MyClass
{..}
24. 将反括号({)放置与新的一行
25. 对于匿名方法参照有规律的代码规划,其缩进应与匿名委托声明对齐
delegate void SomeDelegate (string someString);
//Correct:
public void InvokeMethod()
{
SomeDelegate someDelegate=delegate (string name)
{
Messag