软件项目编码规范.pptVIP

软件项目编码规范JAVA and .NET 武汉软件企业联盟 为什么要实施软件编码规范？ 实施软件编码规范的方针？ 如何实施软件编码规范？ 有什么问题需要大家讨论的吗？ 为什么要实施软件编码规范 源代码剖析：苦活？甜活？ 代码规范很重要 我们用同样的语言交流 愿意去做软件维护的工作吗？ 为什么要实施软件编码规范？ 实施软件编码规范的方针？ 如何实施软件编码规范？ 有什么问题需要大家讨论的吗？ 实施软件编码规范的方针 使代码更清晰和更容易读? 使代码更持续? 使用显而易见的标识符名? 逻辑地组织你的文件和类? 实施软件编码规范的方针 每个文件只有一个类(这里不包括一些内部类) 使用80个字符的最大行宽? 明智的使用空格来（and/or）其他分隔符 缩排上，使用空格（Space）来代替Tab? 为什么要实施软件编码规范？ 实施软件编码规范的方针？ 如何实施软件编码规范？ 有什么问题需要大家讨论的吗？ 如何实施软件编码规范 标识名称命名显而易见 Package 的命名 Class 的命名 Class 变量的命名 实例变量 Static Final 变量的命名 数组的命名 方法的参数 Package 的命名 Package 的名字应该都是由一个小写单词组成。 例如： com.sun.engcom.apple.quicktime.v2edu.cmu.cs.bovik.cheese Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 例如： class Raster;class ImageSprite; Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 例如： char c;int i;float myWidth; 实例变量 大小写规则和类变量名相似，除了前面需要一个下划线 例如： int _employeeId; String _name; Customer _customer; Static Final 变量的命名 Static Final 变量的名字应该都大写，并且指出完整含义。 例如： USER_NAME MAX_WIDTH 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer; 而不是： byte buffer[]; 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size){ this.size = size; } 如何实施软件编码规范 源文件 版权信息 Package/Imports 类定义 Class Fields 存取方法 构造函数 类方法 toString 方法 main 方法 版权信息 版权信息必须在 java 文件的开头 /** * Classname * Version information * Copyright ?2000 XXX Co. Ltd. * All right reserved. */ Package/Imports package 行要在 import 行之前 import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。 如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。 例如： package java.awt; import java.awt.peer.CanvasPeer; 类定义 包含了在不同的行的 extends 和 implements 例如： public class CounterSet extends Observable implements Cloneable Class Fields 类的成员变量 /** * Packet counters */ protected int[] packets; public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。 存取方法 类变量的存取的方法。 /** *Get the Packets */ public int[] getPackets() { return copyArray(packets, offset); } 构造函数 构造函数，它应该用递增的方式写（比如：参数多的写在后面）。 public CounterSet(int size){ this.size = size; } public CounterSet(int size，