C#编程规_范.docVIP

? 项目代码风格要求(C#) 分类：?编程2013-06-14 13:11?138人阅读?评论(0)?收藏?举报 代码风格C#项目效率 目录(?)[+] 代码风格没有正确与否，重要的是整齐划一，这是我拟的一份《项目代码风格要求》，供大家参考。 PDF版下载地址 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，不需要加注释；否则需要添加注释。 当添加注释时，添加方式如下图所示： 优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。 唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示： 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示： 第三步，点击“确定”，完成设置。 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设置制表符。 第三步，点击“确定”，完成设置。 如果两个类型的关系是紧密相关的，比如 产品、产品类型，此时Product类，和ProductType枚举可以定义在同一个Product.cs文件中。 但不能在一个.cs文件中出现两个不相关的类型定义，例如将 Product类和Reseller类（分销商）定义在一个BasicInfo.cs文件中。 当类型命名为Product时，其源文件命名只能是Product.cs。 如下图所示，红色标记的为使用Pascal风格的类型： 注意ProductType是私有类型，不管类型是公有的还是私有的，其命名总是采用Pascal风格。 红色标记的为使用Camel风格的变量或者方法参数： 示例代码如下： 范例1.9 中的if判断实际上与下面的语句是等效的： 示例代码如下： 代码示例如下： 如果需要公有字段，使用属性进行包装。 类型成员的排列顺序自上而下依次为： 字段：私有字段、受保护字段 属性：私有属性、受保护属性、公有属性 事件：私有事件、受保护事件、公有事件 构造函数：参数数量最多的构造函数，参数数量中等的构造函数，参数数量最少的构造函数 方法：重载方法的排列顺序与构造函数相同，从参数数量最多往下至参数最少。 委托以EventHandler作为后缀命名，例如 SalesOutEventHandler。 事件以其对应的委托类型，去掉EventHandler后缀，并加上On前缀构成。 例如，对于SalesOutEventHandler委托类型的事件，其事件名称为：OnSalesOut。 示例代码如下： 如果方法返回的类型为bool类型，则其前缀为Is、Can或者 Try，例如： 凡符合下表所列的集合类型，应添加相应的后缀。 说明 后缀 示例 数组 Array int[] productArray 列表 List ListProduct productList DataTable/HashTable Table HashTable productTable 字典 Dictionary Dictionaystring,string productDictionary EF中的DbSet /DataSet Set DbSetProduct productSet 凡符合下表所列的局部变量、方法参数、字段、属性，均需添加相应的后缀。 说明 后缀 示例 示例说明 费用相关 Cost ShipCost 运输费 价格相关 Price ProductUnitPrice 产品单价 消息相关 Message（弃用Note） SuccessMessage 成功消息 日期相关 Date（弃用Time） OrderDate 下单日期 计数、数量相关 Count（弃用Time） LoginCount 登录次数 链接地址相关 Url BlogUrl 博客链接 图片相关 Image SignImage 签名图片 金额相关 Amount PrepaidAmount 预付款 点数、积分相关 Point MemberPoint 会员积分 记录、日志相关 Record（弃用Log） ErrorRecord 错误记录 配置相关 Config DataBaseConfig 数据库配置 状态相关 Status OrderStatus 订单状态 模式、方式相关 Mode OpenMod