软件编程规范.doc

软件编程规范
编写人
编写日期
审核人
审核日期
批准人
批准日期
文档信息
文档摘要
软件编程规范注重于程序的物理结构和外观,而不是程序的逻辑结构。它们使编码更加容易阅读、容易理解而且容易维护。
相关文档
变更历史
作者
变更内容
变更日期
版本
创建
2008-4-12

修订
修订全局、模块级变量命名规范;
修订参数命名规范;
增加业务逻辑、数据访问、实体对象命名规范;
2008-8-12

修订
数据库索引命名规范
2008-9-1

修订
根据张文金设计的代码自动生成工具归纳总结的一些规范进行补充,另外,将特殊约定部分按页面、业务逻辑、数据访问、数据实体、其他进行了分类整理
2008-9-5

补充
对于过期或不建议再使用的属性或方法做出标记
2008-10-22

修改数据库表索引命名规范
2008-10-30

重要声明
版权所有(C) 2008
地址:
电话:
邮件:
网址:
目录
1. 编程规范 7
. 命名样式规范 7
. 通用命名约定 9
. 特殊命名约定 10
. 变量/常量命名 10
. 控件对象命名 11
. 程序集命名 12
. 命名空间命名 12
. 类型成员命名 13
. 参数命名 14
. 枚举命名 14
. 注释规范 15
. 代码文件注释 15
. 属性和方法注释 15
. 语句的注释 16
. 任务注释 16
. 代码排版规范 16
. 其他编程规范和约定 17
. WEB页面层 17
. 业务逻辑层 17
. 数据访问层 18
. 数据实体层 18
. 其他 18
2. SQL Server编程规范 19
. 命名规范 19
. 数据库 19
. 数据仓库 19
. 数据架构 19
. 表命名 20
. 视图命名 20
. 字段命名 20
. 存储过程命名 21
. 函数命名 21
. 主键、外键、索引命名 21
. 参数、变量命名 22
. 注释规范 22
. 代码注释 22
. 语句的注释 23
. 代码排版规范 23
. SELECT语句排版 24
. INSERT语句排版 24
. UPDATE语句排版 24
. DELETE语句排版 25
. 编程规范 25
. 大小写 25
. 使用“;” 25
. 字段长度 25
. 数据类型选择 25
. 表名别名 26
. 排序 26
. 使用“*” 26
. BEGIN...END 块 26
. 其他编程规范和约定 26
3. JavaScript编程规范 28
. 命名规范 28
. 类命名 28
. 属性、方法命名 28
. 常量、枚举命名 28
. 变量命名 28
. 特殊命名规范 28
. 注释规范 29
. 文件注释 29
. 对象注释 29
. 函数注释 30
. 语句的注释 30
. 排版规范 30
. 块布局 31
. 空白 32
. 编程规范 32
4. 附录 34
. Xml文档注释标记 34
. 部分常用单词缩写 38
. 部分常用字段命名 39
编程规范
命名样式规范
大小写样式
术语
说明
示例
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写
BackColor
Camel大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写
backColor
大写
标识符中的所有字母都大写
IO
小写
标识符中的所有字母都小写
io
标识符的大小写规则
如果标识符由多个单词组成,请不要在各单词之间使用分隔符,如下划线(“_”)或连字符(“-”)等。而应使用大小写来指示每个单词的开