返回
基础
分类

必赢手机登录网址l 对共有以及受保护成员避免使用匈牙利命名法则,命名约定和风格

日期: 2020-03-15 19:22 浏览次数 : 164

命名约定和风格
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
{…}
//避免使用:
public class LinkedList
{…}
12. 使用有意义的命名空间,比如使用公司的名称以及产品的名称。
13. 避免使用完全限定名。而使用using语句替换之。
14. 避免将using语句写在命名空间的内部。
15. 将所有的框架定义的命名空间为一组,自定义的和第三方的命名空间放在另一组。
using System;
using System.Collections.
using System.ComponentModel;
using System.Data;
using MyCompany.
using MyControls;
16. 使用委托的引用替换显式的委托实例。
delegate void SomeDelegate();
public void SomeMethod()
{…}
SomeDelegate someDelegate = SomeMethod;
17. 保持严格的缩进风格。
a. 使用3个空格缩进
b. 不要使用tabs或者其他不标准的缩进,比如1、2、4个空格。
18. 在编写注释的时候注释的缩进和编码的缩进必须是相同级别的。
19. 所有的注释都要通过拼写检查,错误的拼写是粗糙的开发。(针对汉语则要语句通顺易于理解)
20. 所有的成员变量都应该声明在顶部,同时使用一个空行来将他们和属性以及方法分开。
public class MyClass
{
int m_Number;
string m_Name;

1 命名规则与风格
在以前版本的Visual Studio中,微软曾建议使用匈牙利命名法来写代码.在最近发布的.NET和它的编程语言中,微软更换了他的这一法则.

public void SomeMethod1()
{}
public void SomeMethod2()
{}
}
21. 尽可能在第一次使用局部变量的时候申明它。
22. 文件名称应该可以反映出它所包含的类。
23. 当使用不完整的类并且将部分分配到每个文件中,用P+序数作为后缀命名文件。
// in myClassP1.cs
public partial class MyClass
{…}
必赢手机登录网址 ,// in myClassP2.cs
public partial class MyClass
{…}
24. 总是将大括号放在一个新行上。
25. 匿名方法和一般(正规)的方法代码使用相似的代码布局
a. 规定:大括号(方法体的括号)必须使用新行
delegate void SomeDelegate(string someString);
// 正确的是:
public void InvokeMethod()
{
SomeDelegate someDelegate = delegate(string name)
{
MessageBox.Show(name);
};
someDelegate(“Juval”);
}
// 避免使用:
public void InvokeMethod()
{
SomeDelegate someDelegate = delegate(string name){ MessageBox.Show(name);};
someDelegate(“Juval”);
}
26. 在匿名无参方法中要使用空的括号。
a. 如果匿名方法有可能被使用在任何委托中那么可以省略括号。
delegate void SomeDelegate();
// 正确的方法是:
SomeDelegate someDelegate1 = delegate()
{
MessageBox.Show(“Hello”);
}
// 避免使用:
SomeDelegate someDelegate1 = delegate
{
MessageBox.Show(“Hello”);
}

  1. 对格式与方法名称使用PASCAL风格[1]

public class SomeClass

{

public SomeMethod(){}

}

  1. 对局部变量和方法参数使用Camel风格[2]

int number;

void MyMethod(int someNumber)

{}

  1. 使用I作为接口前缀

interface IMyInterface

{..}

  1. 使用m_作为私有成员变量前缀

public class SomeClass

{

private int m_Number;

}

  1. 使用Attribute作为自定义属性类的后缀

  2. 使用Exception作为自定义异常处理类的后缀

  3. 使用动词形式命名方法名,如ShowDialog()

  4. 带有返回值的方法应该有一个方法来描述返回值,如GetObjectStatus()

  5. 使用易描述的变量名称

l 避免使用单一字符描述变量名称,如i或t.应使用index或temp替代

l 对共有以及受保护成员避免使用匈牙利命名法则[3]

l 绝不使用缩写字符,如使用num代替number

  1. 总是使用C#预定义格式,而不使用在System空间内的别名

object NOT 0bject

string NOT String

int NOT Int32

  1. 一般的,对于格式使用大写字母,当处理.NET格式Type时使用Type后缀

//Correct:

public class LinkedList

{..}

//Avoid:

public class LinkedList

{..}

  1. 使用易理解的命名空间[4]名称,如产品或公司名称

  2. 避免使用命名空间的完整限定名称,应使用using声明替代

  3. 避免using声明放置在命名空间内部

  4. 将所有的框架命名空间分组,将用户或第三方命名空间放置在其下

using System;

using System.Collections;

using System.ComponentModel;

using System.Data;

using MyCompany;

using MyControls;

  1. 使用委托引用[5]代替显式的委托实例

delegate void SomeDelegate();

public void SomeMethod()

{..}

SomeDelegate someDelegate=SomeMethod;

  1. 保持严格的缩进

l 对缩进使用3个空格位

l 绝不使用TAB或者不标准的缩进,如1,2或4个空格位

  1. 将注释缩拍在与代码缩进同等级的位置上

  2. 所有的注释应该通过拼写检查.拼错的注释将预示冗余的开发

20. 所有的成员变量应该在开始就被声明,并使用单独一行将属性与方法区域分开

public class MyClass

{

int m_Number;

string m_Name;

public void SomeMethodl()

{}

public void SomeMethod2()

{}

}

  1. 在离第一次使用变量尽可能近的地方声明该局部变量

  2. 文件名称应反映出其包含的类

23. 当使用partial类[6]并将其分配给每个文件一部分时,对每个文件命名使用后缀P并附带一个额外的数字

//In MyClassP1.cs

public partial class MyClass

{..}

// In MyClassP2.cs

public partial class MyClass

{..}

  1. 将反括号({)放置与新的一行

  2. 对于匿名方法参照有规律的代码规划,其缩进应与匿名委托声明对齐

delegate void SomeDelegate (string someString);

//Correct:

public void InvokeMethod()

{

SomeDelegate someDelegate=delegate (string name)

必赢手机登录网址l 对共有以及受保护成员避免使用匈牙利命名法则,命名约定和风格。{

MessageBox.Show(name);

};

someDelegate ("Juval");

}

//Avoid

public void InvokeMethod()

{

SomeDelegate someDelegate=delegate (string name)

{MessageBox.Show(name);};

someDelegate(”Juval");

}

  1. 对于匿名缺省参数的方法,应该使用空括号表示.

delegate void SomeDelegate();

//Correct

SomeDelegate someDelegate1=delegate()

{

MessageBox.Show("Hello");

};

//Avoid

SomeDelegate someDelegate1=delegate

{

MessageBox.Show("Hello");

};

由于本人E文有限,所以翻译注释不当之处,请指明。

稍后是第二部分——编码实践,不过要点时间了,因为会有较多注释(我的习惯啦)


[1] 特指使用Pascal的命名规范命名类型和方法的名字

[2] 特指使用camel命名规范命名局部变量和方法的参数

[3] 匈牙利命名法则:变量名=变量类型+变量的英文意思(或缩写)

[4] namespace用于声明一个范围.此命名空间范围允许您组织代码并为您提供了创建全局唯一类型的方法.

[5] delegate声明定义一种引用类型,该类型可用于将方法用特定的签名封装.委托实例封装静态方法或实例方法. 委托大致类似于C++中的函数指针;但是,委托是类型安全和可靠的

[6] partial简单来说即是使用不完整的类定义并且将部分分配到每个文件中