C#项目代码书写规范说明
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
代码编写规范说明书（c#.net 与 asp.net）
目录
代码编写规范说明书（c#.net 与 asp.net） .................................................................................... 1 1 目的 .............................................................................................................................................. 3 2 范围 .............................................................................................................................................. 3 3 注释规范....................................................................................................................................... 3 3.1 概述.................................................................................................................................... 3 3.2 自建代码文件注释 ............................................................................................................ 4 3.3 模块（类）注释................................................................................................................ 4 3.4 类属性注释........................................................................................................................ 5 3.5 方法注释............................................................................................................................ 5 3.6 代码间注释........................................................................................................................ 5 4 命名总体规则....................................................................................................................... 6 5 命名规范....................................................................................................................................... 6 5.1 变量（Variable）命名 ...................................................................................................... 6 5.2 常量命名............................................................................................................................ 8 5.3 类（Class）命名 ............................................................................................................... 9 5.4 接口（Interface）命名...................................................................................................... 9 5.5 方法（Method）命名 ....................................................................................................... 9 5.6 命名空间（NameSpace）命名......................................................................................... 9 6 编码规则..................................................................................................................................... 10 6.1 错误检查规则.................................................................................................................. 10 6.2 大括号规则...................................................................................................................... 10 6.3 缩进规则.......................................................................................................................... 10 6.4 小括号规则...................................................................................................................... 10 6.5 If Then Else 规则 .............................................................................................................. 11 6.6 比较规则.......................................................................................................................... 11 6.7 Case 规则 .......................................................................................................................... 11 6.8 对齐规则.......................................................................................................................... 11 6.9 单语句规则...................................................................................................................... 12 6.10 单一功能规则................................................................................................................ 12
1 / 20
wk.baidu.com
6.11 简单功能规则 ................................................................................................................ 12 6.12 明确条件规则................................................................................................................ 12 6.13 选用 FALSE 规则 .......................................................................................................... 12 6.14 独立赋值规则................................................................................................................ 12 6.15 定义常量规则................................................................................................................ 12 6.16 模块化规则.................................................................................................................... 13 6.17 交流规则........................................................................................................................ 13 7 编程准则..................................................................................................................................... 13 7.1 变量使用.......................................................................................................................... 13 7.2 数据库操作...................................................................................................................... 13 7.3 对象使用.......................................................................................................................... 13 7.4 模块设计原则.................................................................................................................. 14 7.5 结构化要求...................................................................................................................... 14 7.6 函数返回值原则.............................................................................................................. 14 8 代码包规范................................................................................................................................. 15 8.1 代码包的版本号.............................................................................................................. 15 8.2 代码包的标识.................................................................................................................. 15 9 代码的控制................................................................................................................................. 16 9.1 代码库/目录的建立......................................................................................................... 16 9.2 代码归档.......................................................................................................................... 16 10 输入控制校验规则................................................................................................................... 16 10.1 登陆控制........................................................................................................................ 16 10.2 数据录入控制................................................................................................................ 16 11. 数据库命名规范:..................................................................................................................... 17 附件 1：数据类型缩写表.............................................................................................................. 17 附件 2：服务器控件名缩写表 ...................................................................................................... 18
目录
代码编写规范说明书（c#.net 与 asp.net） .................................................................................... 1 1 目的 .............................................................................................................................................. 3 2 范围 .............................................................................................................................................. 3 3 注释规范....................................................................................................................................... 3 3.1 概述.................................................................................................................................... 3 3.2 自建代码文件注释 ............................................................................................................ 4 3.3 模块（类）注释................................................................................................................ 4 3.4 类属性注释........................................................................................................................ 5 3.5 方法注释............................................................................................................................ 5 3.6 代码间注释........................................................................................................................ 5 4 命名总体规则....................................................................................................................... 6 5 命名规范....................................................................................................................................... 6 5.1 变量（Variable）命名 ...................................................................................................... 6 5.2 常量命名............................................................................................................................ 8 5.3 类（Class）命名 ............................................................................................................... 9 5.4 接口（Interface）命名...................................................................................................... 9 5.5 方法（Method）命名 ....................................................................................................... 9 5.6 命名空间（NameSpace）命名......................................................................................... 9 6 编码规则..................................................................................................................................... 10 6.1 错误检查规则.................................................................................................................. 10 6.2 大括号规则...................................................................................................................... 10 6.3 缩进规则.......................................................................................................................... 10 6.4 小括号规则...................................................................................................................... 10 6.5 If Then Else 规则 .............................................................................................................. 11 6.6 比较规则.......................................................................................................................... 11 6.7 Case 规则 .......................................................................................................................... 11 6.8 对齐规则.......................................................................................................................... 11 6.9 单语句规则...................................................................................................................... 12 6.10 单一功能规则................................................................................................................ 12
1 / 20
wk.baidu.com
6.11 简单功能规则 ................................................................................................................ 12 6.12 明确条件规则................................................................................................................ 12 6.13 选用 FALSE 规则 .......................................................................................................... 12 6.14 独立赋值规则................................................................................................................ 12 6.15 定义常量规则................................................................................................................ 12 6.16 模块化规则.................................................................................................................... 13 6.17 交流规则........................................................................................................................ 13 7 编程准则..................................................................................................................................... 13 7.1 变量使用.......................................................................................................................... 13 7.2 数据库操作...................................................................................................................... 13 7.3 对象使用.......................................................................................................................... 13 7.4 模块设计原则.................................................................................................................. 14 7.5 结构化要求...................................................................................................................... 14 7.6 函数返回值原则.............................................................................................................. 14 8 代码包规范................................................................................................................................. 15 8.1 代码包的版本号.............................................................................................................. 15 8.2 代码包的标识.................................................................................................................. 15 9 代码的控制................................................................................................................................. 16 9.1 代码库/目录的建立......................................................................................................... 16 9.2 代码归档.......................................................................................................................... 16 10 输入控制校验规则................................................................................................................... 16 10.1 登陆控制........................................................................................................................ 16 10.2 数据录入控制................................................................................................................ 16 11. 数据库命名规范:..................................................................................................................... 17 附件 1：数据类型缩写表.............................................................................................................. 17 附件 2：服务器控件名缩写表 ...................................................................................................... 18