JAVA代码规范.doc

第一章 编写目的 3 第二章 阅读对象 3 第三章 定义 3 第四章 基本要求 3 第五章 规范 3 命名规范 3 Package 的命名 4 Class 的命名 4 Class 变量的命名 4 Static Final 变量的命名 4 参数的命名 4 数组的命名 4 方法的参数 4 Java文件样式 5 版权信息 5 Class 5 构造函数 6 类方法 6 toString 方法 7 main 方法 7 代码编写格式 7 文档化 7 缩进 7 页宽 8 {} 对 8 括号 8 程序编写规范 8 exit() 8 异常 9 垃圾收集 9 编程技巧 9 byte 数组转换到 characters 9 Utility 类 9 初始化 10 枚举类型 10 调试 10 资源使用 10 性能 11 日志 11 编写目的 为了规范JAVA程序的开发，便于程序的测试和维护，特制定本标准，对JAVA程序开发和维护过程中的命名规范、文件、代码编写格式、编程技巧、swing组件、调试、性能等内容作出规范化的要求。 阅读对象 JAVA程序开发人员，系统测试和系统维护人员。 定义 匈牙利命名法 基本要求 程序结构清，简单易懂代码精简，避免垃圾程序尽量使用标准库函数和公共函数不要随意定义全局变量，尽量使用局部变量 Package 的名字应该都是由一个小写单词组成(总包名称为网址倒写如：.sl)。包命名为.sl.x.xi(x指系统的名字，xi指系统中模块的名字)如：.sl.ticket.util表示为售票系统的工具包。 Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成。 Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名 Static Final 变量的名字应该都大写，并且指出完整含义。 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer; 而不是： byte buffer[]; 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size){ this.size = size; } Java文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则 版权信息 版权信息必须在 java 文件的开头，比如： /** * Copyright ?2002 SL Co. Ltd. * All right reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里。 Class 接下来的是类的注释，一般是用来解释类的。 /** * 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 */ 接下来是类定义，包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneable Class Fields接下来是类的成员变量： /** * Packet counters */ protected int[] packets; public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。 存取方法接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。 /** * 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,