C#编程规范整理

小编整理了一些C#编程的一些规范,希望对大家有点用处!

1、命名方式

Pascal命名法:每个单词首字母均大写。

Camel命名法:第一个单词首字母小写,其余单词首字母大写。

2、有关类的规范

1、使用 Pascal 大小写。

2、用名词或名词短语命名类,保证类名清晰,尽量达到望文生义的境界。

3、类名称尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明类的用途。

4、不要使用类型前缀,例如,类名称前加上C以表示这是一个类,如:CButton。

5 、类命名中不要使用下划线及数字。

6 、有时候虽然该类不是接口,但需要提供以字母 I 开始的类名称,此时只要 I 是作为类名称组成部分的整个单词的第一个字母,这依然是可行的。例如,类名 IdentityOrder 就是适用的。

类命名示例:

public class FlightBuilder

public class HotelInfo

public class TicketShopper

3、有关接口的规范

1、 接口使用大些字母I做前缀,其后跟名词或名词短语,以描述这个接口,名词和短语使用Pascal方式,如,接口名称 ICache。

2、接口名称尽量少用或不用缩写,保证接口名清晰,尽量达到望文生义的境界,若使用了缩写一定要在注释中详细描述接口的用途。

3、接口名称中不要使用下划线及数字。

接口命名示例:

public interface ICache

public interface IClone

4、有关枚举的规范

1、用短语命名枚举,采用Pascal方式,保证枚举名清晰,尽量达到望文生义的境界。

2、枚举名称尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明枚举的用途。

3、不要在枚举名称后跟上 Enum 后缀,如:OrderFlagEnum。

4、一定不要使用汉字作为枚举值,以免多语言环境下造成莫名。

枚举命名示例:

public enum OrderFlag

{

None,

F

}

5、有关参数的规范

1、使用描述性参数名称,保证参数名称清晰,尽量达到望文生义的境界。

2、参数命名使用 Camel 方,尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明参数的用途。

参数命名示例:

object GetCache(string cacheKey)

bool IsInt(string needCheckString)

6、有关方法的规范

1、用动词或动词短语命名方法名,保证方法名清晰,尽量达到望文生义的境界。

2、采用Pascal方式命名,尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明方法的用途。

方法名示例:

public void ClearCache()

public char[] GetCharArray()

7、有关属性的规范

1、用名词或名词短语命名属性,保证属性名清晰,尽量达到望文生义的境界。

2、采用Pascal方式命名,尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明属性的用途。

属性示例:

public string FlightNo {

get;

set;

}

8、有关变量的规范

1、所有单词大写,多个单词之间用 下划线(”_”)隔开,注意不是全角的下划线。 如

public const int PAGE_INDEX = 6;

2、用名词或名词短语命名局部变量,保证变量名清晰,尽量达到望文生义的境界。

3、采用Camel方式命名,尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明变量的用途。

局部变量命名示例:

int index = 6;

string airline = string.Empty;

private string flightNo = null;

9、有关特性的规范

1、用名词或名词短语+Attribute方式命名特性,保证特性名清晰,尽量达到望文生义的境界。

2、采用Pascal方式命名,尽量少用或不用缩写,若使用了缩写一定要在注释中详细注明特性的用途。

特性命名示例:

public class ValidAttribute : Attribute

{

}

10、有关异常的规范

1、用名词或名词短语+Exception方式命名自定义异常,保证特性名清晰,尽量达到望文生义的境界。

2、采用Pascal方式命名,一定不能使用简写。

异常命名示例:

public class FlightException : ApplicationException

{

}

11、有关委托(delegate)的规范

1、用动词短语命名委托,保证委托名清晰,尽量达到望文生义的境界。

2、采用Pascal方式命名,一定不能使用简写。

委托命名示例:

delegate void PageChange( int pageIndex );

12、有关控件的命名规则

控件众多,统一的命名方式也多有冲突,开发人员记忆所有控件难免弄错,现采用默认控件类型作为前缀,前缀名称全部小写,控件名采用:类型缩写+名词短语(采用Pascal方式),虽然这样会使命名变得冗长,但是命名更加能反应出变量的意义,开发人员也不需要去强记各个控件的缩写。

控件示例:

附录:C#保留关键字:

避免使用与常用的 .NET 框架命名空间重复的类名称。例如,不要将以下任何名称用作类名称:

System、Collections。有关 .NET 框架命名空间的列表,请参阅MSDN类库。

另外,避免使用和以下关键字冲突的标识符。

欢迎关注我的公众号(同步更新文章)DoNet技术分享平台

阅读原文

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容