文档介绍:项目开发规则
C# 命名规范
命名空间
框架中所有命名空间的起始部分
业务中所有命名空间的起始部分
实际结构和名称以业务为准
类
名字应该能够标识事物的特性。
名字可以有两个或三个单词组成,但通常不应多于三个。
采用 Pascal case ,所有单词第一个字母大写。
使用名词或名词短语命名类。
少用缩写。
不要使用下划线字符(_) 。
例:
public class FileStream
public class Button
接口
和类命名规范相同,唯一区别是接口在名字前加上“ I ”前缀
例:
interface IDBCommand
interface IButton
枚举
和类命名规范相同,唯一区别是枚举在名字前加上“ E”前缀
例:
enum ESystemType
方法
使用动词或动词短语命名方法。
采用 Pascal case ,所有单词第一个字母大写。
3) 方法中的参数命名采用 Camel casing, 所有单词第一个字母大写,除了首字母小写。
属性
使用名词或名词短语命名
采用 Pascal case,所有单词第一个字母大写
少用缩写
不要使用下划线字符 ( _ )
变量
1) 变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。
常用变量类型的前缀命名规则,定义如下:
类型 前缀
bool bln
byte byt
char char
double dbl
float flt
integer int
long lng
object obj
string str
常用对象 :
类型 前缀
Collection coll
DateTime dt
DataSet ds
DataReader drd
DataRow dr
DataColumn dc
Hashtable hs
XmlDom xml
XmlReader xr
2) 类的私有变量,在遵循第一条规则后,在其前加“ m_”前缀。
例 :
public class Hello
{
private string m_strName;
public string Name
{
get
{
return m_strName;
}
}
}
即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环
索引使用单字母变量名,如
i
或 j 。
4) 不要使用原义数字或原义字符串,
如 for ( int
i = 1;i
<= 7;i++)
。而是使用命名常数,