C#编码标准--命名约定和风格

命名约定和风格
1. 使用Pascal的命名规范命名类型和方法的名字。
public class SomeClass
{
public SomeMethod(){}
}
2. 使用camel命名规范命名局部变量和方法的参数。
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. 有返回值的方法应该有一个可以描述其返回值的名字,比如:GetObjectState()。
9. 使用有意义的变量名称。
10. 使用C#的预定义的类型而不使用System命名空间中其别名来申明变量。
使用object 而不是 Object
使用string 而不是 String
使用 int 而不是 Int32
11. 通常情况下,类型使用大写字母。当处理.NET的类型的时候使用Type作为其后缀。
//正确的是:
public class LinkedList

 1<k,t>   
 2{…}   
 3//避免使用:   
 4public class LinkedList<keytype,datatype>   
 5{…}   
 612. 使用有意义的命名空间,比如使用公司的名称以及产品的名称。   
 713. 避免使用完全限定名。而使用using语句替换之。   
 814. 避免将using语句写在命名空间的内部。   
 915. 将所有的框架定义的命名空间为一组,自定义的和第三方的命名空间放在另一组。   
10using System;   
11using System.Collections.   
12using System.ComponentModel;   
13using System.Data;   
14using MyCompany.   
15using MyControls;   
1616. 使用委托的引用替换显式的委托实例。   
17delegate void SomeDelegate();   
18public void SomeMethod()   
19{…}   
20SomeDelegate someDelegate = SomeMethod;   
2117. 保持严格的缩进风格。   
22a. 使用3个空格缩进   
23b. 不要使用tabs或者其他不标准的缩进,比如1、2、4个空格。   
2418. 在编写注释的时候注释的缩进和编码的缩进必须是相同级别的。   
2519. 所有的注释都要通过拼写检查,错误的拼写是粗糙的开发。(针对汉语则要语句通顺易于理解)   
2620. 所有的成员变量都应该声明在顶部,同时使用一个空行来将他们和属性以及方法分开。   
27public class MyClass   
28{   
29int m_Number;   
30string m_Name;   
31  
32public void SomeMethod1()   
33{}   
34public void SomeMethod2()   
35{}   
36}   
3721. 尽可能在第一次使用局部变量的时候申明它。   
3822. 文件名称应该可以反映出它所包含的类。   
3923. 当使用不完整的类并且将部分分配到每个文件中,用P+序数作为后缀命名文件。   
40// in myClassP1.cs   
41public partial class MyClass   
42{…}   
43// in myClassP2.cs   
44public partial class MyClass   
45{…}   
4624. 总是将大括号放在一个新行上。   
4725. 匿名方法和一般(正规)的方法代码使用相似的代码布局   
48a. 规定:大括号(方法体的括号)必须使用新行   
49delegate void SomeDelegate(string someString);   
50// 正确的是:   
51public void InvokeMethod()   
52{   
53SomeDelegate someDelegate = delegate(string name)   
54{   
55MessageBox.Show(name);   
56};   
57someDelegate(“Juval”);   
58}   
59// 避免使用:   
60public void InvokeMethod()   
61{   
62SomeDelegate someDelegate = delegate(string name){ MessageBox.Show(name);};   
63someDelegate(“Juval”);   
64}   
6526. 在匿名无参方法中要使用空的括号。   
66a. 如果匿名方法有可能被使用在任何委托中那么可以省略括号。   
67delegate void SomeDelegate();   
68// 正确的方法是:   
69SomeDelegate someDelegate1 = delegate()   
70{   
71MessageBox.Show(“Hello”);   
72}   
73// 避免使用:   
74SomeDelegate someDelegate1 = delegate   
75{   
76MessageBox.Show(“Hello”);   
77}</keytype,datatype></k,t>
Published At
Categories with Web编程
Tagged with
comments powered by Disqus