软件工程实践与项目管理第9章软件编程.ppt

9.1 程序设计风格 9.2 “程序说明书”的撰写 本章小结 习题 9.1 程序设计风格 　　为了提高程序的可读性，程序员应在程序设计风格方面养成良好的习惯，既要保证程序的正确性，同时还必须保证程序的可读性。 　　1.? Java程序设计风格 　　1) 命名规范 　　(1) ?package的命名。package的名字全部由小写字母组成。 　　(2) ?class的命名。class的名字必须由大写字母开头而其他字母都小写。 　　(3) ?class变量的命名。变量的名字必须用小写字母开头。名字中的非最左边的单词用大写字母开头。 　　(4) ?static final变量的命名。组成static final变量名字的字母应该都大写。 　　(5) 参数的命名。参数的名字必须和变量的命名规范一致。 　　(6) 数组的命名。数组应该总是用下面的方式来命名： 　　　　byte[] buffer; 而不是： 　　　　byte buffer[]; 　　(7) 方法的参数。使用有意义的参数名，如果可能的话，使用和所要赋值的字段一样的名字： 　　　　SetCounter(int size) 　　　　{ 　　　　this.size = size; 　　　　} 　　2) ?Java文件样式 　　所有的Java(*.java)文件都必须遵守如下的样式规则。 　　(1) 文件和版权信息。版权信息必须在java文件的开头，比如： 　　(2) ?package/import。package行必须处于import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。如： 　　package hotlava.net.stats; 　　import java.io.*; 　　import java.util.Observable; 　　import hotjava.util.Application; 这里，java.io.*用于代替InputStream and OutputStream的Class。 (3) 类的注释。一般是用来解释类的。如： 　　/** 　　* A class representing a set of packet and byte counters 　　* It is observable to allow it to be watched, but only 　　* reports changes when the current set is complete 　　*/ 　　(4) 类定义。类定义包含在不同的行的extends和implements中。如： 　　　public class CounterSet 　　　extends Observable 　　　implements Cloneable 　　　Class Fields　　 　　(5) 类的成员变量。如： 　　　　/** 　　　　* Packet counters 　　　　*/ 　　　　protected int[] packets; 　　public成员变量必须生成文档(JavaDoc)。proteted、private和 package 定义的成员变量如果具有明确含义的名字，可以没有注释。 　 　　(6) 存取方法。如果它只是简单地将类的变量赋值或获取类的变量值的话，可以简单地写在一行上。如： 　　/** 　　* Get the counters 　　* @return an array containing the statistical data. This array has been 　　* freshly allocated and can be modified by the caller. 　　*/ 　　　public int[] getPackets() { return copyArray(packets, offset); } 　　　public int[] getBytes() { return copyArray(bytes, offset); } 　　　public int[] getPackets() { return packets; } 　　　public void setPackets(int[] packets) { this.packets = packets; } 其他的方法不要写在同一行上。 　　(7) 构造函数。应该以参数数量递增的顺序来写(比如：参数多的写在后面)。访问类型(public、private?等)和任何?static、final?或?synchronized?应该写在一行，而方法和参数则应另写一行，这样可以使方