项目代码风格要求.docx

HYPERLINK /page/179593/ 项目代码风格要求 作者:? HYPERLINK /JimmyZhang/ \t _blank Jimmy Zhang??来源:? HYPERLINK / \t _blank 博客园??发布时间: 2013-06-06 13:37??阅读: 10473 次??推荐: 83??? HYPERLINK /JimmyZhang/archive/2013/06/05/3118936.html \t _blank 原文链接??? HYPERLINK javascript:add_to_wz() [收藏]?? 项目代码风格要求 PDF版下载： HYPERLINK /document/%E9%A1%B9%E7%9B%AE%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E8%A6%81%E6%B1%82.pdf 项目代码风格要求V1.0.pdf 代码风格没有正确与否，重要的是整齐划一，这是我拟的一份《项目代码风格要求》，供大家参考。 1. 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、C