《软件开发代码规范Java》由会员分享，可在线阅读，更多相关《软件开发代码规范Java（17页珍藏版）》请在金锄头文库上搜索。
1、软件开发代码规范(Java) 作者： 日期：软件开发代码规范（C）(仅通普信息技术股份有限公司供内部使用)拟制：杨超日期：2015-3-10审核：夏峰日期：2015-3-10核准：冯敬刚日期：2015-3-17签发：韩殿成日期：2015-3-21文档版本：V1.11黑龙江通普信息技术股份有限公司版本历史日期版本说明作者目录第一章 代码开发规范及其指南11.1 目的11.2 程序内命名规范11.3 文件命名规范21.4 Java 文件样式21.5 代码编写格式6第二章 程序编写规范方法82.1 权限修饰82.2 其他规范82.3 编程指南10第三章 其他要求12第一章 代码开发规范及其指南1.1
2、 目的定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 1.2 程序内命名规范l Package 的命名 ：Package 的名字应该都是由一个小写单词组成。 l Class 的命名 ：Class 的名字必须由大写字母开头而其他字母都小写的单词组成 l Class 变量的命名 ：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 l Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且指出完整含义。 l 参数的命名 ：参数的
3、名字必须和变量的命名规范一致。 l 数组的命名 ：数组应该总是用下面的方式来命名： byte buffer; 而不是 byte buffer;l 方法的参数 ：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size)this.size = size;1.3 文件命名规范l 文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。l Java文件的文件名要与程序中的public类名相同。l Servet文件要以Servlet做为结尾，如AddCompanyServlet.javal 业务处理组件JavaBea
4、n要以Bean为结尾，如ProcessBean.java1.4 Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则 l 头部版权信息 版权信息必须在 java 文件的开头，比如： /* Copyright 2002 Sun Microsystems, Inc. All rights reserved.*/其他不需要出现在 javadoc 的信息也可以包含在这里。l Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，
5、则应该用 * 来处理。 package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里 java.io.* 使用来代替InputStream and OutputStream 的。l Class 接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。 /* * Title: Example * Description: AuditApplicationExample * Copyright: Copyright (c) 200x * Company: xxx
6、xx * author xxxxxx * version 1.0 */接下来是类定义，包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneablel Class Fields 接下来是类的成员变量： /* Packet counters*/protected int packets;public 的成员变量必须生成文档（JavaDoc）。protected、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。l 存取方法 接下来是类变量
7、的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。 /* 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); p
8、ublic int getPackets() return packets; public void setPackets(int packets) this.packets = packets; 其它的方法不要写在一行上l 构造函数 接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。 访问类型 (public, private 等.) 和 任何 static, final 或 synchronized 应该在一行中。 Public CounterSet (int size)this.size = size;l 克隆方法 如果这个类是可以被克隆的，那么下一步就是 clone 方
9、法： public Object clone() try CounterSet obj = (CounterSet)super.clone();obj.packets = (int)packets.clone();obj.size = size;return obj;catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: + e.getMessage();l 类方法 下面开始写类的方法： /* Set the packet counters* (such
10、 as when restoring from a database)*/protected finalvoid setArray(int r1, int r2, int r3, int r4)throws IllegalArgumentException/ Ensure the arrays are of equal size/if (r1.length != r2.length | r1.length != r3.length | r1.length != r4.length)throw new IllegalArgumentException(Arrays must be of the
11、same size);System.arraycopy(r1, 0, r3, 0, r1.length);System.arraycopy(r2, 0, r4, 0, r1.length);l toString 方法 无论如何，每一个类都应该定义 toString 方法： publicString toString() String retval = CounterSet: ;for (int i = 0; i 0) i + ; / 错误, 和 在同一行 if (i0) i + ; / 正确, 单独作为一行 语句永远单独作为一行.如果 语句应该缩进到与其相对应的 那一行相对齐的位置。l 括号 左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:
