18-代码设计精品文档精选.pdfVIP

代码设计 刘钦 1 Outline • 设计易读的代码 • 设计易维护的代码 • 设计可靠的代码 • 使用模型辅助设计复杂代码 • 为代码开发单元测试用例 • 代码复杂度度量 • 问题代码 2 18.1 设计易读的代码 • 维护的需要 • 团队协作的需要 3 代码规范 • 格式 • 命名 • 注释 • ... 4 布局格式 • 使用缩进与对齐表达逻辑结构 5 6 7 布局格式 • 使用缩进与对齐表达逻辑结构 • 将相关逻辑组织在一起 8 类定义的逻辑组织 • 成员变量声明； • 构造方法与析构方法； • public 方法； • protected 方法； • private 方法。 9 相关逻辑组织混乱的代 码 10 逻辑组织清晰的代码 11 布局格式 • 使用缩进与对齐表达逻辑结构 • 将相关逻辑组织在一起 • 使用空行分割逻辑 • 语句分行 12 空行分割复杂控制结构 13 长句断行 14 命名 • 使用有意义的名称进行命名。例如对“销售信息”类，命名为Sales 而 不是ClassA 。 • 使用名词命名类、属性和数据； • 使用名词或者形容词命名接口； • 使用动词或者“动词+名词”命名函数和方法； • 使用合适的命名将函数和方法定义的明显、清晰，包括返回值、 参数、异常等。 • 名称要与实际内容相符。例如，使用Payment 命名“账单”类明显比 使用“Change”更相符，因为“账单”类的职责不仅仅是计 算“Change” ，还要维护账单数据。 • 如果存在惯例，命名时要遵守惯例。例如，Java 语言的命名惯例 是：使用小写词命名包；类、接口名称中每个单词的首字母大写；变 量、方法名称的第一个单词小写，后续单词的首字母大写；常量的每 个单词大写，单词间使用“_”连接。