文档介绍：目录
1. 概述 4
2. 命名规范 4
指导性原则 4
使用正确的大小写风格 4
使用描述性英文名称 4
使用易读的名称 4
尽量避免在名称中使用编码 5
同义词中使用固定的单词 5
保持词义的前后一致 5
名词和动词的选用 5
使用计算机专业术语 5
必要时可使用业务术语 6
避免误导 6
名词需要语境说明 6
不要添加人为的语境 6
避免名称差别不明显造成混淆 6
大写风格 6
Pascal风格 7
Camel风格 7
大写风格 7
大写小结 7
单词选择 8
缩写 8
命名空间 9
类和类成员 9
类的命名指南 9
Attribute命名指南 10
枚举命名指南 10
静态类属性名 10
参数名 10
方法命名指南 11
属性命名指南 11
事件命名指南 11
大小写敏感 12
3. 程序注释规范 12
注释编写准则 12
模块注释 13
类的注释 13
类成员方法的注释 15
类成员属性、常量、变量的注释 16
程序注释 16
4. 代码书写规范 16
排版规范 16
5. 类成员使用规范 20
属性使用指南 20
只读和只写的属性 22
事件使用指南 22
方法使用指南 23
方法重载指南 23
构建函数使用指南 24
类的成员变量使用指南 25
参数名称指南 26
6. 类型使用指南 27
类使用指南 27
基类使用指南 27
值类型使用指南 28
结构使用指南 28
枚举使用指南 28
程序代理使用指南 30
程序属性(Attribute)的使用 30
7. 异常的产生和处理 30
标准异常类型 33
异常的包装Wrapping Exceptions 34
8. 数组使用指南 34
数组vs. 集合 34
集合 34
集合中可索引的属性 34
数组值属性 35
返回空数组 35
9. 数据库设计开发规范 35
命名规范 35
字段设计要求 36
视图使用原则 36
存储过程建立规则 36
函数建立规则 36
触发器使用要求 36
概述
在建设过程中,将涉及到在新的Visual Framework平台上的开发工作。同时,设计人员、开发人员和测试人员较多。为了使应用程序的结构和编码风格标准化,便于阅读和理解编码,以提高开发效率和产品的标准化,制订一套开发规范和标准势在必行。此外,好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。希望开发人员严格遵守此套开发规范和标准,并落实到自己的程序中。
一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。最小编码约定的目的是使程序易于阅读和理解,从而指导程序员更好地完成开发任务。
本规范主要针对使用Visual Framework开发的基于Web的应用系统。
命名规范
指导性原则
命名是编程的核心。能够对变量和函数/过程进行表意清晰而准确的命名,就能使程序的可读性大大提高,达到不说自明的效果。真正的名称是深入认真思考一个对象的生态环境后才能给出的。程序设计人员只有在充分理解并把握整个系统时,才可能给出真正合适的名字。如果名称选用恰当,一切就显得很自然,各部分关系清晰,意义可以推导而出,阅读程序时可以按常识推理,从而减小程序员对已有程序的阅读和理解困难,提高工作效率,使新程序员能在尽量短的时间内进入角色。
以下章节描述了程序命名的一些指导性原则。
使用正确的大小写风格
为保证良好的程序可读性,对命名的大小写必须按照一致的规定编写,主要包括Pascal风格和Camel风格两种,下面将会有专门的章节进行详细说明。
使用描述性英文名称
为保证程序的可读性,要采用准确描述其意义的名字。英语是国际通用语言,绝大多数商业类库或函数库代码都是由英语编写的。要与标