软件工程：Java编程的实践与规范

### 软件工程：Java 编程的实践与规范 #### 1. 软件工程概述 软件工程聚焦于软件的开发、运营和维护，采用系统、规范且可量化的方法。它涵盖了编程实践的诸多方面，旨在设计和开发易于阅读的程序。以下是软件工程的一些关键目标： - 培养良好的编码风格。 - 学会通过封装子任务来简化复杂算法。 - 区分实例变量和局部变量的使用。 - 掌握自上而下和自下而上的设计策略。 - 尽可能使用预编写的软件。 - 认识原型设计的作用。 - 养成频繁且全面测试的习惯。 - 避免不必要地使用 `this` 前缀。 #### 2. 编码风格规范 编码风格规范有助于提高程序的可读性。以下是一些常见的编码风格建议： ##### 2.1 前言部分 每个文件顶部应包含前言部分，其内容和顺序如下： ```plaintext /******************************************************* * 文件名 * 程序员姓名 * * 描述 ********************************************************/ ``` 将前言部分用 `/* ... */` 注释括起来，并在文件名、程序员姓名、空行和描述行前插入星号和空格，使其看起来像一个盒子。 ##### 2.2 命名常量和实例变量 在声明和/或初始化所有命名常量和实例变量的语句块之后，提供一个空行、一行星号和另一个空行。 ##### 2.3 方法描述 每个方法上方应按以下顺序放置内容： ```plaintext // 空行 // 一行星号 // 空行 // 描述 // 空行 ``` 对于简短明显的方法，可以省略方法描述。在简短的构造函数之间以及简短的访问器和修改器方法之间，也可以省略星号线。 ##### 2.4 空行 一般使用空行来分隔代码的逻辑块。例如，在 `StudentDriver` 类中，前言部分和类定义之间、方法的局部变量声明之后都有空行。对于长方法，在方法内逻辑上独立的代码块之间插入空行也是合适的。当注释行出现在代码主体中时，在注释上方留一些空白，使其更易见。 ##### 2.5 有意义的名称 为类和变量使用有意义的名称。例如，`Student` 类是一个很好的命名，因为它模拟了一个学生。类似地，`setName` 是一个设置学生名字实例变量的修改器方法的好名字，`getLast` 是一个返回姓氏的访问器方法的好名字。 ##### 2.6 花括号和缩进 将左花括号 `{` 放在前一行第一个字母的正下方。缩进逻辑上在花括号内的所有内容。完成一个代码块后，“反缩进”，使特定代码块的左右花括号对齐。以下是一个示例： ```java public class StudentDriver { public static void main(String[] args) { Student s1; // first student Student s2; // second student s1 = new Student(); s1.setFirst("Adeeb"); s1.setLast("Jarrah"); s2 = new Student("Heejoo", "Chun"); s2.printFullName(); } // end main } // end class StudentDriver ``` 缩进宽度在 2 到 5 个空格之间都是可以接受的，只要在整个程序中保持一致即可。 ##### 2.7 变量声明 将所有局部变量声明放在方法的顶部（即使编译器不要求）。除非需要 `for` 循环迭代变量在 `for` 循环结束后仍然存在，否则在 `for` 循环头的初始化字段中声明它。通常，每行只声明一个变量。如果几个具有明显含义的变量密切相关，可以将它们放在一行。为每个含义不明显的变量添加注释，并尽量对齐注释。 ##### 2.8 换行 如果一个语句太长，无法放在一行上，在语句内的一个或多个自然断点处拆分它。自然断点包括： - 左括号之后 - 拼接运算符之后 - 分隔参数的逗号之后 - 表达式中的空白处 拆分后，在下一行缩进语句的其余部分。例如： ```java System.out.println("这是一个很长的打印语句，" + "我们在拼接运算符之后进行了换行。"); ``` ##### 2.9 包围单条语句的花括号 对于只包含一个子语句的 `for` 循环或 `if` 语句，省略语句周围的花括号是合法的，但建议始终使用花括号。花括号提供了缩进的视觉提示，并有助于避免在后续添加代码时出现逻辑错误。 ##### 2.10 注释 对于除最短代码块之外的所有代码块，在右花括号后添加注释，以指定正在关闭的代码块。