程序代码规范教程.docx

代码规范V1.0 目录  TOC \o \h \z \u  HYPERLINK \l _Toc456123591 代码规范V1.0  PAGEREF _Toc456123591 \h 1  HYPERLINK \l _Toc456123592 1.C# 代码风格要求  PAGEREF _Toc456123592 \h 2  HYPERLINK \l _Toc456123593 1.1注释  PAGEREF _Toc456123593 \h 2  HYPERLINK \l _Toc456123594 1.2命名  PAGEREF _Toc456123594 \h 3  HYPERLINK \l _Toc456123595 1.2.1通用命名规范  PAGEREF _Toc456123595 \h 3  HYPERLINK \l _Toc456123596 1.2.2文件命名规范  PAGEREF _Toc456123596 \h 3  HYPERLINK \l _Toc456123597 1.2.3命名空间，类，函数命名规范  PAGEREF _Toc456123597 \h 3  HYPERLINK \l _Toc456123598 1.2.4变量命名规范  PAGEREF _Toc456123598 \h 4  HYPERLINK \l _Toc456123599 1.2.5委托和事件的命名  PAGEREF _Toc456123599 \h 5  HYPERLINK \l _Toc456123600 1.3其他规范  PAGEREF _Toc456123600 \h 6  HYPERLINK \l _Toc456123601 1.4常见集合类型后缀命名  PAGEREF _Toc456123601 \h 7  HYPERLINK \l _Toc456123602 1.4.1所列的集合类型，应添加相应的后缀。  PAGEREF _Toc456123602 \h 7  HYPERLINK \l _Toc456123603 1.4.2常见后缀命名(仅供参考)  PAGEREF _Toc456123603 \h 7  HYPERLINK \l _Toc456123604 1.4.3常见类型命名(仅供参考)  PAGEREF _Toc456123604 \h 9  HYPERLINK \l _Toc456123605 1.4.4常见字段、属性命名(仅供参考)  PAGEREF _Toc456123605 \h 9  HYPERLINK \l _Toc456123606 2.数据库代码风格要求  PAGEREF _Toc456123606 \h 10 1.C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，则不需要加注释；否则必须添加注释。 当添加注释时，添加方式如下图所示： 1.2命名 1.2.1通用命名规范 命名优先考虑英文 如果英文没有合适的单词描述，可以使用拼音。 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg、pr等。 1.2.2文件命名规范 一个.cs源文件至多定义两个类型。 类型名称和源文件名称必须一致 当类型命名为Product时，其源文件命名只能是Product.cs。 1.2.3命名空间，类，函数命名规范 所有命名空间，类型名称，函数使用Pascal风格（单词首字母大写） 如下图所示，红色标记的为使用Pascal风格的类型： 注意ProductType是私有类型，不管类型是公有的还是私有的，其命名总是采用Pascal风格。 返回bool类型的方法、属性的命名 如果方法返回的类型为bool类型，则其前缀为Is、Can或者 Try，例如： 1.2.4变量命名规范 参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写）。 自定义数据类型中的成员名称命名方式与数据库命名保持一至。 红色标记的为使用Camel风格的变量或者方法参数： 型内部的私有和受保护字段，使用Camel风格命名，但加“_”前缀 代码示例如下： 1.2.5委托和事件的命名 委托以EventHandler作为后缀命名，例如 SalesOutEventHandler。 事件以其对应的委托类型，去掉EventHandler后缀，并加上On前缀构成。 例如，对于SalesOutEventHandler委托类型的事件，其事件名