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风格命名示例代码如下: |