项目代码风格要求
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类