C# 编码规范

”’1、 类型(类、结构、委托、接口)、字段、属性、方法、事件的命名”’

  优先考虑使用英文(尽量使用英文),如果实在没有合适的英文进行描述,可以使用拼音,使用中文是不符合要求的。

”’2、不使用缩写”’

”’  ”’所有类型、字段、属性、方法、事件尽量不使用缩写,包括大家熟知的缩写,例如msg。

”’3、不使用单个字母的变量”’

  不使用单个字母的变量, 像 i、m、n,使用index等来替换,用于循环迭代的变量除外。

”’4、用Tab作为缩进,并设置缩进大小为4”’

”’5、 注释”’

类型、属性、事件、方法、方法参数,根据需要添加注释。

如果类型、属性、事件、方法、方法参数的名称已经是自解释了,不需要加注释;

否则需要添加注释。

”’6、类型名称和源文件名称一致”’

当类型命名为Product时,其源文件命名只能是Product.cs。

”’8、本地变量、方法参数名使用Camel风格(不使用下划线)”’

红色标记的为使用Camel风格的变量或者方法参数

”’9、在一个类中,各个方法需用一空行(最好是一个空行)”’

”’10、避免使用大文件。如果一个文件里的代码超过300-400行,必须考虑将代码分开到不同的类中。同时避免写太长的方法,如果一个方法代码过长(暂时没有明确指出方法的行数),应该考虑将其分解为不同的方法”’

”’11、一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小”’

”’12、调用类型成员内部其他成员,需加this,调用父类成员需加base”’

”’13、不在代码中使用具体的路径和驱动器名。 使用相对路径,并使路径可复用”’

”’14、不要“捕捉了异常却什么也不做“。如果隐藏了一个异常,你将永远不知道异常到底发生了没有”’

”’15、如果if语句块的内容只有一行,可以不加花括号,并且最好和if语句位于同一行”’

”’16、类型内部的私有字段和受保护字段,使用Camel风格命名,但加“_”前缀”’

”’17、类型成员的排列顺序”’

类型成员的排列顺序自上而下依次为:

字段:私有字段、受保护字段

属性:私有属性、受保护属性、公有属性

事件:私有事件、受保护事件、公有事件

构造函数:参数数量最多的构造函数,参数数量中等的构造函数,参数数量最少的构造函数

方法:重载方法的排列顺序与构造函数相同,从参数数量最多往下至参数最少

”’18、委托和事件的命名”’

委托以!EventHandler作为后缀命名,例如 !SalesOutEventHandler。

事件以其对应的委托类型,去掉!EventHandler后缀,并加上On前缀构成。

示例代码如下:

”’19、返回bool类型的方法、属性的命名”’

如果方法返回的类型是bool类型,则其前缀为Is,例如:!IsHidden。

如果某个属性的类型为bool类型,则其前缀为Can,例如:!CanHidden。

”’20、常见集合后缀类型命名”’

凡符合下表所列的集合类型,应添加相应的后缀。

阅读更多
版权声明:大道至简,悟在天成。本文为博主原创文章,未经博主允许不得转载。http://blog.csdn.net/fwj380891124 https://blog.csdn.net/fwj380891124/article/details/77929893
个人分类: C#语言
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭
关闭