-命名规范.doc

文档介绍：Net-命名标准
.Net编程标准

目 录
一、根底编程标准 3
1. 命名原那么 3
大小写原那么 3
命名标准 3
类的命名原那么 3
UserAlreadyExistsException : PlatformBaseException
｛
｝
参数的命名
参数的名字应该是描述性的
参数的名字应该具有自描述性，也就是说参数的名称可以描述参数在大多数情况下的含义，参数的类型也是可以从参数的名字推断出来的。
参数的名字使用camel Casing〔首字母小写〕
参数的名字是基于参数的含义而不是参数的类型
不要使用保存参数〔Win32 API常见〕
如果下一个版本需要更多的参数，那么加一个overload的方法。
参数的命名例如如下：
Type GetType(string typeName)
String Format(string format, object[] args)
变量的命名
防止无意义的变量命名，如下的命名应该防止：
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"