C# 代码风格要求
来源:互联网 发布:查看centos系统版本 编辑:程序博客网 时间:2024/05/18 04:52
c#命名,代码规范
- C# 代码风格要求
1.1注释
类型、属性、事件、方法、方法参数,根据需要添加注释。
如果类型、属性、事件、方法、方法参数的名称已经是自解释了,不需要加注释;否则需要添加注释。
当添加注释时,添加方式如下图所示:
1.2 类型(类、结构、委托、接口)、字段、属性、方法、事件的命名
优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的。
唯一可以使用中文的地方是枚举的枚举项,枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明,如下图所示:
1.3 不使用缩写
所有类型、方法、参数、变量的命名不得使用缩写,包括大家熟知的缩写,例如msg。
1.4 代码使用半展开
第一步,打开Visual Studio,进入“工具”,“选项…”,如下图所示:
第二步,进入“文本编辑器”,“C#”,“格式设置”,“新行”,取消掉右侧所有复选框中的对号,如下图所示:
第三步,点击“确定”,完成设置。
1.5 使用Tab作为缩进,并设置缩进大小为4
第一步,打开Visual Studio,进入“工具”,“选项…”,如下图所示:
第二步,进入“文本编辑器”,“C#”,“制表符”,如下图所示,设置制表符。
第三步,点击“确定”,完成设置。
1.6 一个.cs源文件至多定义两个类型
如果两个类型的关系是紧密相关的,比如 产品、产品类型,此时Product类,和ProductType枚举可以定义在同一个Product.cs文件中。
但不能在一个.cs文件中出现两个不相关的类型定义,例如将 Product类和Reseller类(分销商)定义在一个BasicInfo.cs文件中。
1.7 类型名称和源文件名称必须一致
当类型命名为Product时,其源文件命名只能是Product.cs。
1.8 所有命名空间、类型名称使用Pascal风格(单词首字母大写)
如下图所示,红色标记的为使用Pascal风格的类型:
注意ProductType是私有类型,不管类型是公有的还是私有的,其命名总是采用Pascal风格。
1.9 本地变量、方法参数名称使用Camel风格(首字母小写,其后每个单词的首字母大写)
红色标记的为使用Camel风格的变量或者方法参数:
1.10 私有方法、受保护方法,仍使用Pascal风格命名
示例代码如下:
1.11 如果if语句内容只有一行,可以不加花括号,但是必须和if语句位于同一行
范例1.9 中的if判断实际上与下面的语句是等效的:
1.12 调用类型内部其他成员,需加this;调用父类成员,需加base
示例代码如下:
1.13 类型内部的私有和受保护字段,使用Camel风格命名,但加“_”前缀
代码示例如下:
1.14 不能出现公有字段
如果需要公有字段,使用属性进行包装。
1.15 类型成员的排列顺序
类型成员的排列顺序自上而下依次为:
字段:私有字段、受保护字段
属性:私有属性、受保护属性、公有属性
事件:私有事件、受保护事件、公有事件
构造函数:参数数量最多的构造函数,参数数量中等的构造函数,参数数量最少的构造函数
方法:重载方法的排列顺序与构造函数相同,从参数数量最多往下至参数最少。
1.16 委托和事件的命名
委托以EventHandler作为后缀命名,例如 SalesOutEventHandler。
事件以其对应的委托类型,去掉EventHandler后缀,并加上On前缀构成。
例如,对于SalesOutEventHandler委托类型的事件,其事件名称为:OnSalesOut。
示例代码如下:
1.17 返回bool类型的方法、属性的命名
如果方法返回的类型为bool类型,则其前缀为Is、Can或者 Try,例如:
1.18 常见集合类型后缀命名
凡符合下表所列的集合类型,应添加相应的后缀。
说明 后缀 示例
数组 Array int[] productArray
列表 List List productList
DataTable/HashTable Table HashTable productTable
字典 Dictionary Dictionay
- C# 代码风格要求
- c#代码项目风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 项目代码风格要求
- 华为代码风格要求
- 腾讯代码风格要求
- 项目代码风格要求(C#)
- 项目代码风格要求(转自博客园-张子阳)
- 页面风格统一要求
- 代码要求
- 代码要求
- 谷歌编程风格要求
- 导航栏切换导航条的移动
- spring实现可动态修改时间定时任务
- Linux网络编程:进程池 + CGI服务器
- 区块链安全与升级
- iOS8.4系统下关于点击UITextField闪退问题
- C# 代码风格要求
- Haproxy+keepalived负载均衡配置
- 我们身边的大数据日常
- Strom Trident详解
- ssm整合pop.xml需要的jar包信息
- Java——ArrayList,Vector,LinkedList的区别
- c# 微信jsapi支付
- 给迷茫不知如何学的UI新手
- 韩信点兵 时间限制:3000 ms | 内存限制:65535 KB 难度:1 描述 相传韩信才智过人,从不直接清点自己军队的人数,只要让士兵先后以三人一排、五人一排、七人一排地变换队形,而他每次只