Java语言编程规范

中经互联网络有限公司Java语言编程规范Version <1.0>目录第一章文件的命名41.1Web文件的命名规范41.2Java文件的命名规范4第二章文件组织52.1文件注释52.2package语句52.3import语句62.4class与interface62.4.1 变量定义62.4.2 instance变量72.4.3 常量72.4.4 方法(method)7第三章缩进与分行10第四章注释114.1 块注释114.2 单行注释114.3 行尾注释124.4 文档注释12第五章声明与定义135.1 变量的定义135.2 class与interface的定义13第六章语句156.1 if, if-else, if else-if else语句156.2 for语句166.3 while语句166.4 do-while语句166.5 switch语句176.6 try-catch语句17第七章空行与空白197.1 空行197.2 空格19第八章参考21第九章编码范例22第一章文件的命名1.1Web文件的命名规范文件名称：jsp、html、images文件名一律小写，Html的文件扩展名为“htm”。

文件名均采用“_”进行分割，第一个单词表示模块名称或简称，以后的单词为页面功能描述，（如果一个单词无法描述可以采用多个单词，但必须用分割符进行分割），最后的一个单词如果是功能实现结果页则为“result”，如果是功能实现页，则无。

例如：psms_add_account_result.jsp表示是添加账户功能管理模块，添加账户的实现结果页。

psms_add_account.jsp表示是添加账户功能管理模块，添加账户的功能页。

1.2Java文件的命名规范为保证公司全球范围内的命名唯一性，建议采用如下的命名规范：包名：com.wideway.+项目名，如：com.wideway.sms类名：以大写的WY(Wideway)开头，如：WYException工具类：工具类统一放在com. wideway.util包中第二章文件组织一个Java源文件由package语句、import语句、class、interface和method 等几部分组成。

各部分之间由空行分隔，每部分之前应有注释说明。

每个Java源文件包括一个public class或public interface，与该public class或public interface密切相关的private class或private interface应置于同一个文件中。

public class 或 public interface的定义应放在private class和private interface之前。

2.1文件注释所有的Java源文件都应该以注释开始，说明文件信息、版本信息版权声明。

例如：2.2package语句package名应由小写字母和“.”组成。

为了保证万纬公司Java产品的全球范围内命名的唯一性，建议按公司产品名组织 package名，例如：2.3import语句import语句用来装载源文件中所需要的类。

例如：2.4class与interface在每个class或interface之前均应有符合javadoc规范的文档注释，描述该类的介绍、作者、版本信息等。

应该有这个类的使用说明，工具类最好附有例子代码。

例如：Class和Interface的命名规范：class和interface名应为描述性的大小写字母混合组成，第一个字母为大写。

例如：class 或interface的定义遵循下列顺序及约定。

2.4.1 变量定义变量名应为描述性的大小写字母混合组成。

应按照 public， protected， packaged (无描述符) 和 private 的顺序定义。

2.4.2 instance变量例如：2.4.3 常量绝对避免在源程序中出现常数，除－1，0和1以外的任何常数均必须定义为常量。

常量名应为“_”分隔的全大写字母。

例如：2.4.4 方法(method)在每个方法前均应有符合javadoc规范的文档注释，描述该方法的介绍、参数、返回值等。

例如：** <p> This method implements the general contract of the corresponding* <code>{@link Reader#read(char[], int, int) read}</code> method of the* <code>{@link Reader}</code> class. As an additional convenience, it* attempts to read as many characters as possible by repeatedly invoking* the <code>read</code> method of the underlying stream. This iterated* <code>read</code> continues until one of the following conditions becomes * true: <ul>** <li> The specified number of characters have been read,** <li> The <code>read</code> method of the underlying stream returns* <code>-1</code>, indicating end-of-file, or** <li> The <code>ready</code> method of the underlying stream* returns <code>false</code>, indicating that further input requests* would block.** </ul> If the first <code>read</code> on the underlying stream returns* <code>-1</code> to indicate end-of-file then this method returns* <code>-1</code>. Otherwise this method returns the number of characters * actually read.** <p> Subclasses of this class are encouraged, but not required, to* attempt to read as many characters as possible in the same fashion.** <p> Ordinarily this method takes characters from this stream's character * buffer, filling it from the underlying stream as necessary. If,* however, the buffer is empty, the mark is not valid, and the requested* length is at least as large as the buffer, then this method will read* characters directly from the underlying stream into the given array.* Thus redundant <code>BufferedReader</code>s will not copy data* unnecessarily.** @param cbuf Destination buffer* @param off Offset at which to start storing characters* @param len Maximum number of characters to read** @return The number of characters read, or -1 if the end of the* stream has been reached** @exception IOException If an I/O error occurs*/public int read(char cbuf[], int off, int len) throws IOException {synchronized (lock) {ensureOpen();if ((off < 0) || (off > cbuf.length) || (len < 0) ||((off + len) > cbuf.length) || ((off + len) < 0)) {throw new IndexOutOfBoundsException();} else if (len == 0) {return 0;}int n = read1(cbuf, off, len);if (n <= 0) return n;while ((n < len) && in.ready()) {int n1 = read1(cbuf, off + n, len - n);if (n1 <= 0) break;n += n1;}return n;}}方法名应为描述性的大小写字母混合组成，第一个字母为小写。

例如：通过“set”方法设置类/对象的属性，通过“get”方法获取非boolean类型的属性，通过“is”或“can”方法获取boolean类型的属性。

例如：第三章缩进与分行采用2个空格作为缩进的单位。

避免80个字符以上的行的出现，每行尽量少于70个字符。

对于过长行的分行原则：∙在逗号“,”之后分行∙在运算符之前分行∙以运算符优先级作为分行原则例如：对于if语句可适当变通缩进原则，提高可读性。