C#编程规范--命名篇(整理) 转贴

1.用pascal规则来命名方法和类.(第一个单词首字母大写，后面连接的每个单词首字母都大写）
public class DataBase ；public void GetDataTable()

2.用camel规则来命名局部变量和方法的参数. (第一个单词不大写，后面连接的单词首字母大写)
public void AddUser(string userId, byte[] password)
{ string userName;}

3.所有的成员变量前加前缀 _
public class Database
{ private string _connectionString; }

4.接口的名称加前缀 I
interface ICompare
{ int compare(); }

5.自定义代码属性类以Attribute结尾
public class OperationAttribute : Attribute

6.自定义的异常以Exception结尾
public class AppException : Exception

7.方法的命名.一般将其命名为动宾短语.
GetRecordData();GetPath();CreateFile();

8.代码的缩进.要用Tab，而不要用space.

9.局部变量的名称要有意义.不要用x，y，z等等(除用于For循环变量中可使用i,j,k,l,m,n).

10.所有的成员变量声明在类的顶端，用一个换行把它和方法分开.

11.用有意义的名字命名namespace，如：产品名、公司名.

12.建议局部变量在最接近使用它时再声明.

13.使用某个控件的值时，尽量命名局部变量.

14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开.

15.文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类.

16.目录结构中要反应出namespace的层次.

17.大括号"{"要新起一行

以下几点是推荐的命名方法。

1、避免容易被主观解释的难懂的名称，如方面名 AnalyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。

2、在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用 Book.Title。

3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。

4、在变量名中使用互补对，如 min/max、begin/end 和 open/close。

5、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。

6、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。 （此项只供参考）

7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原义数字或原义字符串，如

For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。