编写高质量代码

编程及规范化

# 编程的概念
1.软件编程是一个复杂而迭代的过程，它不仅仅是编写代码，还应该包括代码审查、
单元测试、代码优化、集成调试等一系列工作。
2.编码就是把软件设计结果翻译成用某种程序设计语言书写的程序。
# 选择适宜的程序设计语言的原因：
1.根据设计去完成编码时，困难最少；
2.可以减少需要的程序测试量；
3.可以得到更容易阅读和更容易维护的程序。

(一)源程序文档化
(1)标识符的命名
含义鲜明的名字、缩写规则一致、为名字加注解。
^安排注释
正确性，简要描述模块的功能、主要算法、接口特点、重要数据以及开发简史或解释包含这段代码的必要性。
^程序的视觉组织
适当的阶梯形式使程序的层次结构清晰明显。
(2)程序的注释
^夹在程序中的注释是程序员与日后的程序读者之间通信的重要手段。
①序言性注释：
通常置于每个程序模块的开头部分，它应当给出程序的整体说明，对于理解程序本身具有引导作用。
序言性注释包括：
 程序标题；
有关本模块功能和目的的说明；
 主要算法；
 接口说明：包括调用形式，参数描述，子程序清单；
 有关数据描述：重要的变量及其用途，约束或限制条件，以及其它有关信息；
 模块位置：在哪一个源文件中，或隶属于哪一个软件包；
 开发简历：模块设计者，复审者，复审日期，修改 日期及有关说明等。
②功能性注释:
功能性注释嵌在源程序体中，用以描述其后的语句或程序段是在做什么工作，或是执行了下面的语句会怎么样，而不要解释下面怎么做。
(二)数据说明
(1)数据说明的次序应该标准化。有次序易查阅，能加速测试、调试和维护的过程。
(2)当多个变量名在一个语句中说明时，应该按字母顺序排列这些变量。
           例如，把
           integer  size, length, width, cost, price         写成         integer cost, length, price , size, width

(3)如果设计时使用了一个复杂的数据结构，则应该用注解说明用程序设计语言实现这个数据结构的方法和特点。
(三)语句构造
构造语句时应该遵循的原则是，每个语句都应该简单而直接，不能为了提高效率而使程序变得过分复杂；也不要刻意追求技巧性，使程序编写得过于紧凑。

高质量的设计

(一)模块化设计
基于单一职责：类或者函数应该只做一件事，
并且做好这件事。

(二)设置异常处理

代码复审

结对编程

结对编程（英语：Pair programming）是一种敏捷软件开发的方法，两个
程序员在一个计算机上共同工作。一个人输入代码，而另一个人审查他输入
的每一行代码。输入代码的人称作驾驶员，审查代码的人称作观察员（或
导航员）。两个程序员经常互换角色。