net编码规范.docx
- 文档编号:27169449
- 上传时间:2023-06-27
- 格式:DOCX
- 页数:27
- 大小:27.71KB
net编码规范.docx
《net编码规范.docx》由会员分享,可在线阅读,更多相关《net编码规范.docx(27页珍藏版)》请在冰豆网上搜索。
net编码规范
C#代码编写规范
1注释
1.1类c注释
该类注释用于
1不再使用的代码。
2临时测试屏蔽某些代码。
用法
/*
[修改标识]
[修改原因]
...(源代码)
*/
常用于文件头部注释,标注出创始人、创始时间、修改人、修改时间、代码的功能等。
例如
/********************************************************************
**作者:
张三
**创始时间:
2010-9-1
**修改人:
李四
**修改时间:
2010-9-15
**描述:
**主要用于产品信息的资料录入,…
*********************************************************************/
1.2单行注释
该类注释用于
1方法内的代码注释。
如变量的声明、代码或代码段的解释。
注释示例:
//
//注释语句
//
privateintnumber;
或
//注释语句
privateintnumber;
2方法内变量的声明或花括号后的注释,注释示例:
if(1==1)//总为true
{
statement;
}//总为true
1.3注释标签
标签
用法
作用
c>text
text希望将其指示为代码的文本。
使用将多行文本标记为代码
content段落文本。
用于诸如
name为方法参数名。
将此名称用单引号括起来('')。
应当用于方法声明的注释中,以描述方法的一个参数。
name
要引用的参数名。
将此名称用双引号括起来("")。
可以处理XML文件,从而用某种独特的方法格式化该参数。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member传递给输出XML中的元素名。
必须将member括在双引号("")中。
从文本内指定链接。
使用
cref="member"引用当前编译环境调用的成员或字段。
编译器检查到给定代码元素存在后,将member传递给输出XML中的元素名。
必须将member括在双引号("")中
指定希望在“请参阅”一节中出现的文本
description
代码示例的说明。
使用
一般情况下,这将涉及到标记的使用。
content
content为希望将其标记为代码的文本。
提供了一种将多行指示为代码的方法。
使用
此处description为对象的摘要。
应当用于描述类型成员。
使用
cref="member"对可从当前编译环境中获取的异常的引用。
编译器检查到给定异常存在后,将member转换为输出XML中的规范化元素名。
必须将member括在双引号("")中。
description说明。
filename包含文档的文件名。
该文件名可用路径加以限定。
将filename括在单引号中('')。
Tagpath:
filename中指向标记名的标记路径。
将此路径括在单引号中('')。
name注释前边的标记中的名称说明符;名称具有一个id。
id
位于注释之前的标记的id。
将此id括在双引号中("")。
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
有关自定义
term定义的项,该项将在text中定义。
description目符号列表或编号列表中的项或者term的定义。
定义表时,只需为标题中的项提供一个项。
列表中的每一项用
创建定义列表时,既需要指定term也需要指定text。
但是,对于表、项目符号列表或编号列表,只需为text提供一个项。
列表或表所拥有的
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member转换为输出XML中的规范化元素名。
必须将member括在双引号("")中。
description成员的访问的说明。
System.Security.PermissionSet指定对成员的访问。
description成员的说明。
description返回值的说明。
property-description属性的说明。
请注意,当在VisualStudio.NET开发环境中通过代码向导添加属性时,它将会为新属性添加
然后,应该手动添加
2声明
2.1每行声明数
一行只作一个声明,并按字母顺序排列。
如
intlevel;//推荐
intsize;//推荐
intx,y;//不推荐
2.2初始化
变量声明时初始化。
2.3位置
变量置于程序段的开始处,不必在第一次使用时声明。
如
voidMyMethod()
{
intint1=0;//方法开始
if(condition)
{
intint2=0;//"if"语句程序段开始
...
}
}
不过也有一个例外
for(inti=0;i { ... } 应避免不同层次间的变量重名,如 intcount; ... voidMyMethod() { if(condition) { intcount=0;// ... } ... } 2.4类和接口的声明 1在方法名与其后的左括号间没有空格。 2左花括号“{”出现在声明的下行并与之对齐,单独成行。 3方法间用一个空行隔开。 2.5字段的声明 不使用public或protected实例字段。 将字段直接公开给开发人员,可以更轻松地对类进行版本控制,原因在于维护二进制兼容性时字段不能被更改为属性。 考虑为字段提供get和set属性访问器,而不是使它们成为公共的。 get和set属性访问器中的可执行代码使得后续改进成为可能,如在使用属性或者得到属性更改通知时根据需要创建对象。 下面的代码示例阐释怎样正确使用带有get和set属性访问器的私有实例字段。 示例: publicclassControl: Component { privateinthandle; publicintHandle { get { returnhandle; } } } 3命名规范 3.1大小写规则 大写 仅对于由两个或者更少字母组成的标识符采用全部大写的形式。 例如 System.IO System.Web.UI 下表汇总了大写规则,并提供了不同类型的标识符的示例。 标识符 大小写 示例 命名空间 Pascal System.Drawing 类 Pascal AppDomain 方法 Pascal ToString 属性 Pascal BackColor 公共实例字段 Pascal RedValue 注意很少使用。 属性优于使用公共实例字段。 事件 Pascal ValueChange 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 异常类 Pascal WebException 异常总是以Exception后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable 接口总是以I前缀开始。 受保护的实例字段 Camel redValue 很少使用。 属性优于使用受保护的实例字段。 私有的实例字段 Camel redValue 参数 Camel typeName 方法内的变量 Camel backColor 3.2命名空间 1、命名命名空间时的一般性规则是使用公司名称,后跟技术名称和可选的功能与设计,如下所示。 CompanyName.TechnologyName[.Feature][.Design] 例如: namespaceLangchao.Procurement//浪潮公司的采购单管理系统 namespaceLangchao.Procurement.DataRules//浪潮公司的采购单管理系统的业务规则模块 2、命名空间使用Pascal大小写,用逗号分隔开。 3、TechnologyName指的是该项目的英文缩写,或软件名。 4、命名空间和类不能使用同样的名字。 例如,有一个类被命名为Debug后,就不要再使用Debug作为一个名称空间名。 3.3类 1、使用Pascal大小写。 2、用名词或名词短语命名类。 3、使用全称尽量不要缩写,除非缩写已是一种公认的约定,如URL、HTML 4、不要使用类型前缀,如在类名称上对类使用C前缀。 例如,使用类名称FileStream,而不是 CFileStream。 5、不要使用下划线字符(_)。 6、有时候需要提供以字母I开始的类名称,虽然该类不是接口。 只要I是作为类名称组成部分的整个单词的第一个字母,这便是适当的。 例如,类名称IdentityStore是适当的。 在适当的地方,使用复合单词命名派生的类。 派生类名称的第二个部分应当是基类的名称。 例如,ApplicationException对于从名为Exception的类派生的类是适当的名称,原因ApplicationException是一种Exception。 请在应用该规则时进行合理的判断。 例如,Button对于从Control派生的类是适当的名称。 尽管按钮是一种控件,但是将Control作为类名称的一部分将使名称不必要地加长。 publicclassFileStream publicclassButton publicclassString 3.4方法 以下规则概述方法的命名指南: 1使用动词或动词短语命名方法。 2使用Pascal大小写。 3以下是正确命名的方法的实例。 RemoveAll() GetCharArray() Invoke() 3.5字段 以下规则概述字段的命名指南: 1、private、protected使用Camel大小写。 2、public使用Pascal大小写。 3、拼写出字段名称中使用的所有单词。 仅在开发人员一般都能理解时使用缩写。 字段名称不要使用大写字母。 下面是正确命名的字段的示例。 classSampleClass { stringurl; stringdestinationUrl; } 4、不要对字段名使用匈牙利语表示法。 好的名称描述语义,而非类型。 5、不要对字段名或静态字段名应用前缀。 具体说来,不要对字段名称应用前缀来区分静态和非静态字段。 例如,应用g_或s_前缀是不正确的。 6、对预定义对象实例使用公共静态只读字段。 3.6静态字段 以下规则概述静态字段的命名指南: 1、使用Pascal大小写。 2、使用名词、名词短语或者名词的缩写命名静态字段。 3、对静态字段名称使用匈牙利语表示法前缀。 4、尽可能使用静态属性而不是公共静态字段。 3.7属性(Attribute) 将后缀Attribute添加到自定义属性类。 以下是正确命名的属性类的示例。 publicclassObsoleteAttribute { } 3.8属性(property) 以下规则概述属性的命名指南: 1使用名词或名词短语命名属性。 2使用Pascal大小写。 3不要使用匈牙利语表示法。 4考虑用与属性的基础类型相同的名称创建属性。 例如,如果声明名为Color的属性,则属性的类型同样应该是Color。 请参阅本主题中后面的示例。 以下代码示例阐释正确的属性命名。 publicclassSampleClass { publicColorBackColor { //GetandSet的访问代码. } } 以下代码示例阐释提供其名称与类型相同的属性。 publicenumColor { //枚举值 } publicclassControl { publicColorColor { get { //此处添加代码 } set { //此处添加代码 } } } 以下代码示例不正确,原因是Color属性是Integer类型的。 publicenumColor { //枚举值 } publicclassControl { publicintColor { //此处添加代码 } } 在不正确的示例中,不可能引用Color枚举的成员。 Color.Xxx将被解释为访问一个成员,该成员首先获取Color属性(C#中为int类型)的值,然后再访问该值的某个成员(该成 员必须是System.Int32的实例成员)。 3.9参数 以下规则概述参数的命名指南: 1、使用描述性参数名称。 参数名称应当具有足够的描述性,以便参数的名称及其类型可用于在大多数情况下确定它的含义。 2、对参数名称使用Camel大小写。 3、使用描述参数的含义的名称,而不要使用描述参数的类型的名称。 开发工具将提供有关参数的类型的有意义的信息。 因此,通过描述意义,可以更好地使用参数的名称。 少用基于类型的参数名称,仅在适合使用它们的地方使用它们。 4、不要使用保留的参数。 保留的参数是专用参数,如果需要,可以在未来的版本中公开它们。 相反,如果在类库的未来版本中需要更多的数据,请为方法添加新的重载。 5、不要给参数名称加匈牙利语类型表示法的前缀。 以下是正确命名的参数的示例。 TypeGetType(stringtypeName) stringFormat(stringformat,args()Asobject) 3.10事件 以下规则概述事件的命名指南: 1、对事件处理程序名称使用EventHandler后缀。 2、指定两个名为sender和e的参数。 sender参数表示引发事件的对象。 sender参数始终是object类型的,即使在可以使用更为特定的类型时也如此。 与事件相关联的状态封装在名为e的事件类的实例中。 对e参数类型使用适当而特定的事件类。 3、用EventArgs后缀命名事件参数类。 4、考虑用动词命名事件。 5、使用动名词(动词的“ing”形式)创建表示事件前的概念的事件名称,用过去式表示事件后。 例如,可以取消的Close事件应当具有Closing事件和Closed事件。 不要使用BeforeXxx/AfterXxx命名模式。 6、不要在类型的事件声明上使用前缀或者后缀。 例如,使用Close,而不要使用OnClose。 7、通常情况下,对于可以在派生类中重写的事件,应在类型上提供一个受保护的方法(称为OnXxx)。 此方法只应具有事件参数e,因为发送方是类型的实例。 以下示例阐释具有适当名称和参数的事件处理程序。 publicdelegatevoidMouseEventHandler(objectsender,MouseEventArgse); 以下示例阐释正确命名的事件参数类。 publicclassMouseEventArgs: EventArgs { intx; inty; publicMouseEventArgs(intx,inty) { this.x=x; this.y=y; } publicintX { get { returnx; } } publicintY { get { returny; } } } 3.11接口 以下规则概述接口的命名指南: 1、用名词或名词短语,或者描述行为的形容词命名接口。 例如,接口名称IComponent使用描述性名词。 接口名称ICustomAttributeProvider使用名词短语。 名称IPersistable使用形容词。 2、使用Pascal大小写。 3、少用缩写。 4、给接口名称加上字母I前缀,以指示该类型为接口。 在定义类/接口对(其中类是接口的标准实现)时使用相似的名称。 两个名称的区别应该只是接口名称上有字母I前缀。 5、不要使用下划线字符(_)。 6、当类是接口的标准执行时,定义这一对类/接口组合就要使用相似的名称。 两个名称的不同之处,只是接口名前有一个I前缀。 以下是正确命名的接口的示例。 publicinterfaceIServiceProvider publicinterfaceIFormatable 以下代码示例阐释如何定义IComponent接口及其标准实现Component类。 publicinterfaceIComponent { //代码实现. } publicclassComponent: IComponent { //代码实现. } 3.12常量(const) 以下规则概述常量的命名指南: 所有单词大写,多个单词之间用"_"隔开。 如 publicconststringPAGE_TITLE="Welcome"; 对象本身的公共静态只读字段。 使用Pascal大小写,原因是字段是公共的。 下面的代码 示例阐释公共静态只读字段的正确使用。 publicstructColor { publicstaticreadonlyColorRed=newColor(0x0000FF); publicColor(intrgb) { //此处添加代码} publicColor(byter,byteg,byteb) { //此处添加代码 } publicbyteRedValue { get { returnColor; } } } 3.13枚举(Enum) 枚举(Enum)值类型从Enum类继承。 以下规则概述枚举的命名指南: 1对于Enum类型和值名称使用Pascal大小写。 2少用缩写。 3不要在Enum类型名称上使用Enum后缀。 4对大多数Enum类型使用单数名称,但是对作为位域的Enum类型使用复数名称。 5将FlagsAttribute添加到位域Enum类型。 3.14集合 集合是一组组合在一起的类似的类型化对象,如哈希表、查询、堆栈、字典和列表,集合命名用复数。 3.15缩写 为了避免混淆和保证跨语言交互操作,请遵循有关缩写的使用规则: 1不要将缩写或缩略形式用作标识符名称的组成部分。 例如,使用GetWindow,
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- net 编码 规范