java程序的编码规范(2)
作者:李小敏 本文选自:ibm dw中国 2002年08月21日
其他不需要出现在 javadoc 的信息也可以包含在这里。
● package/imports
package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。
package hotlava.net.stats;
import java.io.*;
import java.util.observable;
import hotlava.util.application;
这里 java.io.* 使用来代替inputstream and outputstream 的。
● 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, offset); }
public int[] getpackets() { return packets; }
public void setpackets(int[] packets) { this.packets = packets; }
其它的方法不要写在一行上。
Java Asp PHP .Net XML C/C++ CGI VB Jsp J2ee J2se J2me EJB Servlet Tomcat Resin Struts Weblogic Eclipse ANT GUI JMS Web servise IDEA Webphere Hibernate Spring Jboss Applet Swing Socket Javamail Perl Ajax P2P 安全 模式 框架 测试 开源 游戏
Windows XP Windows 2000 Windows 2003 Windows Me Windows 9.x Linux UNIX 注册表 操作系统 服务器 应用服务器