C#命名规则和开发习惯
2024-07-21 02:19:10
供稿：网友
c# coding standard
一、命名
1.用pascal规则来命名方法和类型.
public class textbox
{
public void databind()
{
}
}
2.用camel规则来命名局部变量和方法的参数.
string username;
public adduser(string userid, byte[] password);
3.所有的成员变量前加前缀 m_
public class database
{
public string m_connectionstring;
}
4.接口的名称加前缀 i.
interface icompare
{
int compare();
}
5.自定义的属性以attribute结尾
public class authorattribute : attribute
{
}
6.自定义的异常以exception结尾
public class appexception : exception
{
}
7.方法的命名.一般将其命名为动宾短语.
showdialog()
createfile()
getpath()
8.代码的缩进.要用tab，而不要用space.
9.局部变量的名称要有意义.不要用x，y，z等等.
string username
10.所有的成员变量声明在类的顶端，用一个换行把它和方法分开.
11.用有意义的名字命名namespace，如：产品名、公司名.
12.建议局部变量在最接近使用它时再声明.
13.使用某个控件的值时，尽量命名局部变量.
14.把引用的系统的namespace和自定义或第三方的分开.
15.文件名要能反应类的内容，最好是和类同名，一个文件中一个类.
16.目录结构中要反应出namespace的层次.
17.大括号"{"要新起一行.
public class authorattribute : attribute
{
}
二、编码习惯.
1.用c#预定义的类名，而不要用别名.
string username; 而不是 system.string username;
int number; 而不是 system.int32;
2.一行不要超过80个字符.
3.尽量不要手工更改机器生成的代码，若必须更改，一定要改成和机器生成的代码风格一样.
4.关键的语句(包括声明关键的变量)必须要写注释.
5.文字常量和数字常量不要硬编码，应该用常量类或枚举代替.
6.不要用goto系列语句.
7.不要声明public和protected的成员变量，应用property.
8.不要声明public的event，应用事件访问器.
public class source
{
private eventhandler m_numberchangeevent;
public event eventhandler numberchangeevent
{
add
{
m_numberchangeevent += value;
}
remove
{
m_numberchangeevent -= value;
}
}
}
9.类型转换的使用规则.
animal animal = new dog();
dog dog = animal as dog;
if (dog != null)
{
}
10.生成和构建一个长的字符串时，一定要使用stringbuilder，而不用string.
11.始终使用"{ }"包含if下的语句，即使只有一条语句.
12.switch语句一定要有default来处理意外情况.
13.尽量不要使用三目运算符 ? : ，而要使用if语句.
14.尽量不用使用this引用，除非是要调用类中的另一个constructor.
public class person
{
public person(string name)
{
}
public person() : this("jim")
{
}
}
