8 编写高质量代码.pptVIP

编写高质量代码 编写高质量代码 良好的编程风格 代码审查与优化 结对编程实践 软件编程工作 软件编程是一个复杂而迭代的过程，它不仅仅是编写代码，还应该包括代码审查、单元 测试、代码优化、集成调试等一系列工作。 编写代码 代码优化 系统构建 集成调试 单元测试 代码审查 系统模型 源代码 软件编程规范 软件编码规范是与特定语言相关的描写如何编写代码的规则集合。 现实 • 软件全生命周期的 70% 成本是维护 • 软件在其生命周期中很少由原编写人员进行维护 目的 • 提高编码质量，避免不必要的程序错误 • 增强程序代码的可读性、可重用性和可移植性 软件编程规范-注释 • 形式1：由 # 开头的“真正的”注释，说明选择当前实现的原因以及这种实现的原理和难点； • 形式2：文档字符串，说明如何使用包、模块、类、函数（方法），甚至包括使用示例和单元测试。 • 好的注释解释为什么，而不是怎么样 • 不要在注释中重复描述代码 • 当自己在编写密密麻麻的注释来解释代码时，需要停下来看是否存在更大的问题 • 想一想在注释中写什么，不要不动脑筋就输入 • 写完注释之后要在代码的上下文中回顾一下，它们是否包含正确的信息？ • 当修改代码时，维护代码周围的所有注释 软件编程规范-注释 学会只编写够用的注释，过犹不及，重视质量而不是数量。 总体规则：不要随意缩写，如果说ChangeLocalValue写作ChgLocVal有情可原的话，把ModifyPlayerName写作MdfPlyNm就太过分了，除函数名可适当为动词外，其他命名尽量使用清晰易懂的名词； 宏、枚举等使用全部大写+下划线； 变量（类、结构体的成员变量）、文件、命名空间、存取 函数（与成员变量相同）等使用全部小写+下划线，类成员 变量以下划线结尾，全局变量以g_开头； 普通函数、类型（类、结构体、枚举类型）、常量（k开头） 等使用大小写混写，不用下划线。 软件编程规范-命名 软件编程规范-语句的构造 不要为了节省空间而把多个语句写在同一行； 程序编写首先应当考虑清晰性，不要刻意追求技巧性。 程序编写得要简单，写清楚，直截了当地说明程序员的用意。 尽量避免复杂的条件测试； 尽量减少对“非”条件的测试； 避免大量使用循环嵌套和条件嵌套； 利用括号使逻辑表达式或算术表达式的运算 次序清晰直观。 代码审查 代码审查（Code Review）是一种用来确认方案设计和代码实现的质量保证机制，它通过阅读代码来检查源代码与编码规范的符合性以及代码的质量。 代码优化 优化是对代码进行等价变换，使得变换后的代码运行结果与变换前的代码运行结果相同，但执行速度加快或存储开销减少。 • 在满足正确性、可靠性、健壮性、可读性等质量因素的前提下，设法提高程序的效率 • 以提高程序的全局效率为主，提高局部效率为辅 • 在优化程序效率时，应先找出限制效率的“瓶颈” • 先优化数据结构和算法，再优化执行代码 • 时间效率和空间效率可能是对立的，应当分析哪一个因素更重要，再做出适当的折衷 代码优化 • 从一开始就要考虑程序性能，不要期待在开发结束后再做一些快速调整 • 正确的代码要比速度快的代码重要，任何优化都不能破坏代码的正确性 • 认真选择测试数据，使其能够代表实际的使用状况 • 永远不要在没有执行前后性能评估的情况下尝试对代码进行优化 结对编程（Pair programming）