软件开发代码规范Java.docx

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第二章 程序编写规范方法 . 92.1 权限修饰 . 92.2 其他规范 . 92.3 编程指南 . 11第三章 其他要求 13第一

2、章 代码开发规范及其指南1.1 目的定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增 加可读性，减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝 对遵守，但是一定要让程序有良好的可读性)1.2 程序内命名规范Package 的命名 ： Package 的名字应该都是由一个小写单词组成。Class 的命名 ： Class 的名字必须由大写字母开头而其他字母都小写的单 词组成Class 变量的命名 ：变量的名字必须用一个小写字母开头。后面的单词用 大写字母开头。Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且 指出完整含义。参数的

3、命名 ：参数的名字必须和变量的命名规范一致。数组的命名 ：数组应该总是用下面的方式来命名： byte buffer; 而不 是 byte buffer;方法的参数 ：使用有意义的参数命名，如果可能的话，使用和要赋值的字 段一样的名字：SetCounter(int size) this.size = size;1.3文件命名规范文件名由英文单词组成，每个单词的首字母大写，不要超过 4个单词,如 ShipOrder.jsp 。Java文件的文件名要与程序中的public类名相同。Servet 文件要以 Servlet 做为结尾，如 AddCompanyServlet.java 业务处理组件Java

4、 Bean要以Bean为结尾，如 ProcessBean.java1.4 Java文件样式所有的Java(*java) 文件都必须遵守如下的样式规则头部版权信息版权信息必须在java文件的开头，比如：/* Copyright 2002 Sun Microsystems, Inc. All rights reserved.*/其他不需要出现在javadoc的信息也可以包含在这里Package/lmportspackage行要在import 行之前，import中标准的包名要在本地的包名之 前，而且按照字母顺序排列。如果 import行中包含了同一个包中的不同子目 录，则应该用*来处理。packa

5、ge hotlava .n et.stats;import java.io.*;import java.util.Observable;import hotlava.util.Applicati on;、二V匚口 这里 java.10.使用来代替 InputStream and Outputstream 的。Class接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、* Title: Example* Descripti on: AuditApplicati on Example* Copyright: Copyright (c) 200x* Compa ny: xxxxx* a

6、uthor xxxxxx* versio n 1.0*/接下来是类定义，包含了在不同的行的 exte nds 和impleme ntspublic class Coun terSet exte nds Observable impleme nts Cion eableClass Fields接下来是类的成员变量:* Packet coun ters*/protected in t packets;public 的成员变量必须生成文档（ JavaDoc）。protected、private 和package定义的成员变量如果名字含义明确的话，可以没有注释。存取方法接下来是类变量的存取的方法。它只

7、是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上* Get the coun ters* return an array containing the statistical data. This array has bee n* freshly allocated and can be modified by the caller.*/public int getPackets() return copyArray(packets, offset); public in t getBytes() return copyArray(bytes, offset); public in

8、t getPackets() retur n packets; public void setPackets(i nt packets) this.packets = packets; 其它的方法不要写在一行上构造函数接下来是构造函数，它应该用递增的方式写(比如：参数多的写在后面)。 访问类型(public, private 等.) 和 任何static, final或synchroni zed 应该在一行中。Public Cou nterSet (int size)this.size = size;克隆方法如果这个类是可以被克隆的，那么下一步就是 clone方法:public Object

9、cion e() try Coun terSet obj = (Co un terSet)super.clo ne();obj.packets = (in t)packets.clo ne();obj.size = size;return obj;catch(CI on eNotSupportedExcepti on e) throw new InternalError(Unexpected CioneNotSUpportedException:+ e.getMessage();类方法F面开始写类的方法:/* Set the packet coun ters* (such as whe n r

10、estori ng from a database)*/protected finalvoid setArray(int r1, int r2, int r3, int r4)throws IliegalArgume ntExceptio n/ En sure the arrays are of equal size/if (rl.le ngth != r2.le ngth | rl.le ngth != r3.le ngth |rl.length != r4.length)must be of the samethrow new IllegalArgumentException(Arrays

11、size);System.arraycopy(r1,0, r3, 0, r1 .len gth);System.arraycopy(r2, 0, r4, 0, r1 .len gth);toStri ng 方法无论如何，每一个类都应该定义toStri ng 方法:publicString toString() Stri ng retval =Cou nterSet:;for (i nt i = 0; i 0) i + ; / 错误, 和在同一行if (i0) i +; / 正确,单独作为一行语句永远单独作为一行如果语句应该缩进到与其相对应的那一行相对齐的位置括号左括号和后一个字符之间不应该出现空格，同样，右括号和前一个字符之 间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用 ：CallProc( AParameter ); / 错误CallProc(AParameter); / 正确不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码 中。下面的例子说明错误和正确的用法：if (I) = 42) /错误- 括号毫无意义