C#编码规范
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
C#编码指南——.NET平台上可读的C#代码
内容提纲:
概述
1.C#编码的基础
2.Naming命名
2.1.类命名
2.2.接口命名
2.3.方法命名
2.4.属性命名
2.5.事件命名
3.注释
3.1.文件头注释
3.2.类和成员头
3.3.代码中的注释
3.4.分层
4.格式
4.1.在表达式中多使用括号
4.2.每行一个动作
4.3.分行的位置
4.4.在每行的最后保留一个运算符
4.5.对连续的行进行缩进
4.6.重写代码
4.7.标准空格
4.8.可选的空格
4.9.大括号
4.10.宽度
概述
本文档的目标在于为开发者提供必要的指南,以帮助开发者创建、审核和维护C#组件。出于此目的,我们将讨论诸如命名约定,代码格式和注释等方面的问题。
1.C#编码的基础
C#语言、.NET框架以及Visual 为开发提供一个全新的、强大的平台。C#语言、编程模式以及开发工具在很多方面的改进使得很多对基于C++和C的代码标准的推荐已经不再适用。制定一套适合这个新的平台的开发标准变得十分重要。
本文档试图通过制定编码指南来完善C#编码的基础。这些指南将针对那些创建、审核和维护C#组件的开发人员而不是那些某一组件的使用者。
2Naming命名
出于明确和便于参考的考虑,在这里列举命名原则:
1.使用描述性的命名
2.不要使用匈牙利命名法:不要使用作用域或类型前缀
3.使用Pascal Casing (例如B ack C olor)来命名一个类向外部暴露的名字
4.使用Camel Casing (例如b ack C olor)来命名一个类内部使用的名字(包括参数和私有成员,但是不包括方法)
5.对于常数不要使用特殊的命名法,常数的命名原则和其他标示相同
6.只使用公共的缩写
7.i , j和k可以作为循环的索引使用,但是必须限制在循环内使用
需要注意的时,由于不再使用作用域前缀,一个属性的命名和属性内部的储存成员的命名的差别可能只是首字母的大小写。(例如:属性BackColor将其值储存在成员backColor中)。
2.1.类命名
●用名词或是名词短语来命名类
●使用PascalCasing方式命名
●命名时尽量不要使用缩写
●不用使用类前缀(例如:“C”)
●不要使用下划线
2.2接口命名
●使用名词或名词短语合适描述行为的形容词来命名接口
●使用PascalCasing方式命名
●命名时尽量不要使用缩写
●不要使用下划线
●在接口名字前使用“I”前缀以说明该类型为接口
●当一个类是某一接口的标准是现时,使用相似的名字来命名这个类和相应接口
2.3方法命名
●使用动词或动词短语来命名方法
●使用PascalCasing来命名方法(对私有方法也应当使用PascalCasing)。
●使用camelCasing来命名参数
2.4属性命名
●使用名词或名词短语来命名属性
●使用PascalCasing来命名属性
2.5事件命名
●在事件处理器的命名后加上“EventHandler”后缀
●使用名字为sender和e的两个参数
●命名事件变量类时使用“EventArgs”后缀
●对于有时间先后概念的事件,命名时应该采用相应的时态。例如一个可能被取消的“close”事件,应该有 Closing和Closed两个事件
●考虑使用动词来命名事件
3.注释
3.1文件头注释
下面是将被使用的标准头文件注释,记得添加你的姓名到
//------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//
//------------------------------------------------------------------
3.2类和成员头
Header comments are an important way of communicating code purpose and usage. All classes and all of their public methods should have appropriate header comments. C#’s XML documentation tags will be used to allow automatic generation of class summaries from the code comments. This is as simple as using /// as comment prefixes and learning a few XML tags. 头注释是表述代码的目的和使用的重要方式。所有的类和公共方法应该有相应的头注释,在c#中,可以使用“///”自动生成头注释信息。
在头注释中应该包括以下内容:
●简单的描述:使用
●适当的时候需要一些详细的描述(包括可能出现的问题以及假设等等):使用
●参数的描述:使用标记
●使用