Csharp命名规则说明

发布 2023-05-03 19:52:28 阅读 8151

名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 getnextstudent(),而不是 getnextarrayelement()。

命名原则是:

选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。

表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。

以下几点是推荐的命名方法。

1、避免容易被主观解释的难懂的名称,如方面名 analyzethis(),或者属性名 xxk8。这样的名称会导致多义性。

2、在类属性的名称中包含类名是多余的,如 而是应该使用

3、只要合适,在变量名的末尾或开头加计算限定符(**g、sum、min、max、index)。

4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。

5、布尔变量名应该包含 is,这意味着 yes/no 或 true/false 值,如 fileisfound。

6、在命名状态变量时,避免使用诸如 flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentflag,而是使用更具描述性的名称,如 documentformattype。

(此项只供参考)

7、即使对于可能仅出现在几个**行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。 可能的情况下,尽量不要使用原义数字或原义字符串,如。

for i = 1 to 7。而是使用命名常数,如 for i = 1 to num_days_in_week 以便于维护和理解。

大写。标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:

下表汇总了大写规则,并提供了不同类型的标识符的示例。

为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:

1 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 getwindow,而不要使用 getwin。

2 不要使用计算机领域中未被普遍接受的缩写。

3 在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 ui 作为 user interface 缩。

写,用 olap 作为 on-line analytical processing 的缩写。

4在使用缩写时,对于超过两个字符长度的缩写请使用 pascal 大小写或 camel 大小写。例如,使用 htmlbutton 或 htmlbutton。但是,应当大写仅有两个字符的缩写,如,而不是

5 不要在标识符或参数名称中使用缩写。如果必须使用缩写,对于由多于两个字符所组成的缩写请。

使用camel 大小写,虽然这和单词的标准缩写相冲突。

1、命名命名空间时的一般性规则是使用公司名称,后跟技术名称和可选的功能与设计,如下所示。

例如:namespace 浪潮公司的采购单管理系统。

namespace //浪潮公司的采购单管理系统的业务规则模块。

2、命名空间使用pascal大小写,用逗号分隔开。

3、technologyname 指的是该项目的英文缩写,或软件名。

4、命名空间和类不能使用同样的名字。例如,有一个类被命名为debug后,就不要再使用debug作为一个名称空间名。

1、使用 pascal 大小写。

2、用名词或名词短语命名类。

3、使用全称避免缩写,除非缩写已是一种公认的约定,如url、html

4 、不要使用类型前缀,如在类名称上对类使用 c 前缀。例如,使用类名称 filestream,而不是

cfilestream。

5 、不要使用下划线字符 (_

6 、有时候需要提供以字母 i 开始的类名称,虽然该类不是接口。只要 i 是作为类名称组成部分的整个单词的第一个字母,这便是适当的。例如,类名称 identitystore 是适当的。

在适当的地方,使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如,applicationexception 对于从名为 exception 的类派生的类是适当的名称,原因applicationexception 是一种exception。

请在应用该规则时进行合理的判断。例如,button 对于从 control 派生的类是适当的名称。尽管按钮是一种控件,但是将 control 作为类名称的一部分将使名称不必要地加长。

public class filestream

public class button

public class string

以下规则概述接口的命名指南:

1、用名词或名词短语,或者描述行为的形容词命名接口。例如,接口名称 icomponent 使用描述性。

名词。接口名称 icustomattributeprovider 使用名词短语。名称 ipersistable 使用形容词。

2、使用 pascal 大小写。

3、少用缩写。

4、给接口名称加上字母 i 前缀,以指示该类型为接口。在定义类/接口对(其中类是接口的标准。

实现)时使用相似的名称。两个名称的区别应该只是接口名称上有字母 i 前缀。

5、不要使用下划线字符 (_

6、当类是接口的标准执行时,定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处。

只是接口名前有一个i前缀。

以下是正确命名的接口的示例。

public interface iserviceprovider

public interface iformatable

以下**示例阐释如何定义 icomponent 接口及其标准实现 component 类。

public interface icomponent

implementation code goes here.

public class component: icomponent

implementation code goes here.

应该总是将后缀 attribute 添加到自定义属性类。以下是正确命名的属性类的示例。

public class obsoleteattribute

枚举 (enum) 值类型从 enum 类继承。以下规则概述枚举的命名指南:

1 对于 enum 类型和值名称使用 pascal 大小写。

2 少用缩写。

3 不要在 enum 类型名称上使用 enum 后缀。

4 对大多数 enum 类型使用单数名称,但是对作为位域的 enum 类型使用复数名称。

5 总是将 flagsattribute 添加到位域 enum 类型。

以下规则概述参数的命名指南:

1、使用描述性参数名称。参数名称应当具有足够的描述性,以便参数的名称及其类型可用于在大多数情况下确定它的含义。

2、对参数名称使用 camel 大小写。

3、 使用描述参数的含义的名称,而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此, 通过描述意义,可以更好地使用参数的名称。

少用基于类型的参数名称,仅在适合使用它们的地方使用它们。

4、不要使用保留的参数。保留的参数是专用参数,如果需要,可以在未来的版本中公开它们。相反,如果在类库的未来版本中需要更多的数据,请为方法添加新的重载。

5、不要给参数名称加匈牙利语类型表示法的前缀。

以下是正确命名的参数的示例。

type gettype(string typename)

string format(string format, args() as object)

考勤规则说明

鹿岛公司考勤规则条款 待修正 1 公司或店内打卡时间 上班时间为 9 00 或15 00 打卡有效时间为上班前后30分钟内 之前为正常,之后为迟到 下班时暂不用打卡 00 9 30 15 00 15 30 期间打卡的为迟到,9 30 15 30 以后的打卡行为视为无效 旷工半天或全天 30 15 3...

拓扑规则说明

1.拓扑规则简介。在实际应用时,有时需要在要素之间保持某种特定的关系,比如,行政管理的范围不能相互重叠,线状道路之间不能有重叠线段,某些汽车站必须在公共交通线路上等,这些特定的空间关系可用拓扑学来描述 定义。借助geodatabase,可规定一系列拓扑规则,在要素之间建立起空间关系,还可以对这些规则...

20122019规则说明

2012 2014年国际篮球规则变动说明 前言 国际篮球总会自2010年土耳其世界男篮锦标赛之后,在10月1日开始实施2010年国际篮球规则,其最大的变动就是3分线增长50公分,由6.25米增加到6.75米 同时增设禁区中的免责冲撞区 以及前场发球区的设立 等,让比赛增加许多变数与可看性。国际篮球规...