设计文档介绍及讨论教程.ppt

问题与回答 * 活动过程名称 2009年1月1日 主讲人:某某某 活动过程名称 2009年1月1日 主讲人:某某某 设计文档介绍及讨论模板的版本号：1.1.1 编号：RZ-RC-OT-18- * 修订履历 计划工时* 修订日期 修订原因 修订内容 修订人 版本号 消耗工时* 说明：“计划工时”指估算编写本教材的工时；“消耗工时”指实际消耗工时。 日程介绍 代码文件编码规范 数据库编码规范 业务逻辑概要设计 页面逻辑概要设计 * 代码文件编码规范 Pascal和Camel命名法 代码文件格式 注释 命名 内容 * * Pascal命名法和Camel命名法 两种命名方式均被.NET Framework类库使用。 Pascal命名法 由一系列单词组成，每个单词的首字母大写，其它字母小写，不要使用下划线。例子：WebForm、HttpRequest。 Camel命名法 和Pascal命名法类似，区别在于首字母小写。例子：firstPage, lastPage。 * 代码文件格式 尽量不要使用太宽的行。不要超过160个西方字符（每个汉字相当于2个西方字符） 正确地折行，折行以后需要正确地缩进。 规范使用空格、括号、花括号。 Visual Studio 可以根据预定义的模板自动进行格式化。需要使用公司提供的格式化模板 * 注释 避免使用过于花哨和装饰性的注释。 注释必须有意义，注释用于帮助代码的阅读者理解代码。 不要包含版本控制和修订的信息。这些工作由版本控制系统完成更加合适。 不要包含完全无用的注释。 不要包含错误的注释。 在一个长方法（50行以上）中使用注释。 长方法必然包含比较复杂的业务逻辑，所以必须加入注释。 * 注释（续） 对外的方法必须加入注释 对外的方法往往被其他人阅读，所以必须加入注释。 对参数进行注释。 参数名往往比较简短，通过参数名不一定可以直观知道这个参数的含义。 简要说明每个参数的具体含义。更详细的描述可以放在文档中。 在复杂的控制语句周围使用注释。 控制语句表示业务逻辑，复杂的控制语句表示复杂的业务逻辑。 * 命名 基本原则 除了用于循环体的变量以及短生命周期变量之外，任何变量命名都应当有富有意义。比如int maxValue 的意义比 int x 更利于阅读和理解。 循环体变量应当选择i,j,k,l,m,n等等。 循环体变量具有大家默认的含义，所以不必太长。 循环体变量会被多次引用，所以不必太长。 短生命周期变量可以采用简写，比如int idx。 短生命周期变量指：定义之后就被使用，并且很快就不再使用的。 * 命名（续） 基本原则 类和方法的命名都应当清晰且富有意义。 同一个概念前后命名要统一 名词、动词前后尽量一致。不要混合使用Person、People或者StartDate、BeginDate或者Add、Insert。 全部使用缩写，或者全部不用缩写。全部用indexId或者全部用idxId。 对外的方法，参数顺序也应当尽量一致。 同一个逻辑含义的方法，应当尽量同名，通过重载参数列表来区分。 任何时候都不应当采用中文命名。 拼音缩写命名应当尽量少采用。 混合使用英文和拼音会导致阅读困难。 拼音本身很难做到见名知义。 * 命名（续） 名字空间 使用Pascal命名法或者缩写。 例子：System.Web.Utils、System.IO 常量 全部大写， 多个单词之间用下划线连接。例子：MIN_DATE，MAX_DATE。 变量和参数 局部变量采用Camel命名法。尽量采用形容词+名词的方式。例子：totalPrice, hiddenText。因为变量往往表示主语或者宾语。例如：user.Upload(report); 成员变量采用“m_”前缀。 不要使用类型前缀。 只读变量同常量。 * 命名（续） 接口 接口采用Pascal命名法，要求尽可能采用形容词，并且应当加入“I”前缀。比如IThrowable。 接口的含义是能够实现某些功能，比如IDisposable表示可以被释放，IClonable表示可以复制。 类 类采用Pascal命名法，要求尽可能采用形容词+名词的方式。比如FastCache。 如果某个类继承自其它类，则尽可能采用修饰词+父类名的方式，比如XmlConfigurator 继承自 父类 Configurator。 对于集合类型，应当采用基类型+“Collection”后缀。 对于特性类型，即继承自System.Attribut