C#编码规则

摘录与其他网站

C#编码规则

规则约定 举例(说明)

用pascal规则来命名方法类型

public class MyClass
public void DataBind();

用camel规则来命名局部变量和方法的参数

public void  AddUser(string  userId )
{
string userName;
……
}

所有的类成员变量前加前缀 _
对外公开名称用pascal规则命名;

private class MyClass
{
private string _userName;
public string UserName
{
get {}
set {}
}
}

接口的名称加前缀I.

Interface  ICompare

枚举的命名是Pascal命名

public enum ProductType{……}

常量命名全部大写,单词间以下划线间隔,

public const int LOCK_SECONDS = 3000;

自定义的属性以Attribute结尾

public class AuthorAttribute:Attribute

自定义的异常以Exception结尾

public class  MyException:Exception

方法的命名.一般将其命名为动宾短语.

ShowDialog();

用有意义的名字命名namespace,如:产品名、公司名.

 

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

 

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

 

函数、属性、类等注释请使用///三斜线注释,

这种注释是基于XML的,不仅能导出XML制作帮助文档,而且在各个函数、属性、类等的使用中,编辑环境会自动带出注释,方便你的开发。以protected,protected Internal,public声明的定义注释请都以这样命名方法。

文件头部注释标注出创始人、创始时间、修改人、修改时间、代码的功能,

这在团队开发中必不可少,它们可以使后来维护/修改的同伴在遇到问题时,在第一时间知道他应该向谁去寻求帮助,并且知道这个文件经历了多少次迭代、经历了多少个程序员的手。

使用空格
1: 双目操作符的前后加空格
2: 单目操作符前加空格
3: 逗号、分号只在后面加空格

 

 

 

使用空行
在一段功能代码、或者函数、属性之间插入空行,这样会很直观。

 

类的成员数据/方法调用时,应该加上this限定符

this在编辑环境中是蓝色的,更利于我们区分局部变量、参数或静态变量,并且利于FXCop检测区分

命名缩写
不要使用缩写命名

我们从来不害怕长的变量命名,而却担心看不懂的命名。好的命名不需要注释;

文字常量和数字常量不要硬编码,应该用常量类或枚举代替.

 

尽量少使用三目运算符?:,而要使用if语句

 

不要声明public的event,应用事件访问器

public class Source
{
private EventHandler _changeEvent;
public event EventHandlerChangeEvent
{
add
{
_changeEvent += value;
}
remove
{
_changeEvent -= value;
}
}
}

拒绝使用悬挂式的大括号

 

你可能感兴趣的:(C#编码规则)