Net-命名规范.doc

文档介绍：Net-命名规范
.Net编程规范
目 录
一、基础编程规范 1
1. 命名原则 1
大小写原则 1
命名规范 2
类的命名原则 2
接口命名原则 2
：
Contract a = new Contract();
但以下情况除外，作为循环条件中的计数器：
for ( int i = 0; i < MaxNum; i++)
.Net编程规范

方法命名原则
用动词或动词短语来命名
用Pascal命名约定
方法的命名示例如下：
RemoveAll()
Char[] GetCharArray()
属性命名原则
属性名称使用名词或名词短语
用Pascal命名约定
可以考虑用类型名称作为属性名称
属性的命名示例如下：
Public Color Color
{
Get{}
Set{}
}
大小写敏感
，应该在无论大小写敏感或不敏感的语言中都能使用。因为需要大小写敏感的语言不能识别两个相同内容但用大小写区分的名字，所以组件必须避免这种情况
不要出现两个只用大小写区分的命名空间，如
namespace ;
namespace ;
不要出现两个只用大小写区分的参数如.
void foo(string a, string A)
不要出现只用大小写区分的同一命名空间的类型
p;
pp;
不要出现只用大小写区分的同一类型属性。
int Foo {get, set};
int FOO {get, set}
不要出现两个只用大小写区分的方法
void foo();
void Foo();
注释
注释通用原则
原则上平均每100行代码中要有20～30行注释，视程序复杂程度而定。
所有注释应使用中文。
对于源文件和类，必须在注释中说明修改历史。
.Net编程规范

类和接口的注释
，具体内容如下：
/// <summary>
/// <see cref="IUserManager"/>接口定义了<see cref="User"/>实体类的增、删、改、读
/// （CRUD）方法，该接口的实现类将负责用户对象的简单管理。
/// </summary>
/// <remarks>
/// <see cref="IUserManager"/>接口仅定义<see cref="User"/>实体对象的CRUD操作方法，
/// 并没有定义关联用户对象与群组、组织机构等的操作，这些业务逻辑操作的方法定义在
/// 专门的关联操作接口<see cref="IUserGroupAssociator"/>及<see cref="IUserOrgAssociator"/>中。
/// </remarks>
/// Title: IUserManager