问问大家Java得代码规范是什么? 我还是延续c++里面的命名规范的。不过没有m_,g_这种的前缀了 解决方案 » 免费领取超大流量手机卡,每月29元包185G流量+100分钟通话, 中国电信官方发货 如果想知道java代码规范,你应该看看这个:是个好东东!!!http://www-900.ibm.com/developerWorks/cn/java/java_standard/index.shtml Java 程序编码规范 本文出自:不详 作者:李小敏 IBM.com (2002-02-01 06:15:00) 所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适 应,但是在多个开发人员 共同写作的情况下,这些规则是必需的。这不仅仅是为了开 发效率来考虑,而且也是为了后期维护考虑。 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少 项目组中因为换人而带来 的损失。(这些规范并不是一定要绝对遵守,但是一定要让 程序有良好的可读性) Package 的命名 Package 的名字应该都是由一个小写单词组成。 Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名 Static Final 变量的名字应该都大写,并且指出完整含义。 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名: byte[] buffer; 而不是: byte buffer[]; 方法的参数 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字: SetCounter(int size){ this.size = size; } Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则 版权信息 版权信息必须在 java 文件的开头,比如: /** * Copyright ? 2000 Shanghai XXX Co. Ltd. * All right reserved. */ 其他不需要出现在 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; } 其它的方法不要写在一行上 构造函数 接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。 访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 应该在一行中,并且 方法和参数另写一行,这样可以使方法和参数更易读。 public CounterSet(int size){ this.size = size; } 克隆方法 如果这个类是可以被克隆的,那么下一步就是 clone 方法: 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()); } } 类方法 下面开始写类的方法: /** * Set the packet counters * (such as when restoring from a database) */ protected final void 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 same size"); System.arraycopy(r1, 0, r3, 0, r1.length); System.arraycopy(r2, 0, r4, 0, r1.length); } toString 方法 无论如何,每一个类都应该定义 toString 方法: public String toString() { String retval = "CounterSet: "; for (int i = 0; i < data.length(); i++) { retval += data.bytes.toString(); retval += data.packets.toString(); } return retval; } } main 方法 如果main(String[]) 方法已经定义了, 那么它应该写在类的底部. 命名规范呢?比如C++中int liNum = 0;Java中呢?C++:TClass *lpObject = new TClass();Java中呢?至少没有p得概念吧我看到Java程序,包括书中得程序都没有命名规范,到处得变量名字根本不能一幕了然看出类型来,觉得特别不爽。到底有没有命名规范啊 关于三层结构中用接口的优点是什么? 如何设置JtextField可以输入的字符宽度 学了半年java偶这个都不知道:( 转行了,低价处理一批java书,适合入门学习用.(北京) 第一天学JAVA请问怎么配置sdk呀?什么进入编辑的界面? 求Acrobat SDK的有效下载地址! 面试题 请问worker class 和 application class有什么区别? 为什么不能删除DLL?(急1急!在线等) 在Java中什么是"Shallow clone"和"deep clone"? 请问这样会有几个线程存在? 快疯了,帮帮我吧!
http://www-900.ibm.com/developerWorks/cn/java/java_standard/index.shtml
本文出自:不详 作者:李小敏 IBM.com (2002-02-01 06:15:00)
所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适
应,但是在多个开发人员 共同写作的情况下,这些规则是必需的。这不仅仅是为了开
发效率来考虑,而且也是为了后期维护考虑。 命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少
项目组中因为换人而带来 的损失。(这些规范并不是一定要绝对遵守,但是一定要让
程序有良好的可读性)
Package 的命名
Package 的名字应该都是由一个小写单词组成。
Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成
Class 变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。
Static Final 变量的命名
Static Final 变量的名字应该都大写,并且指出完整含义。
参数的命名
参数的名字必须和变量的命名规范一致。
数组的命名
数组应该总是用下面的方式来命名: byte[] buffer;
而不是: byte buffer[]; 方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字: SetCounter(int size){
this.size = size;
}
Java 文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则
版权信息
版权信息必须在 java 文件的开头,比如: /**
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出现在 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; }
其它的方法不要写在一行上
构造函数
接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。
访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized"
应该在一行中,并且 方法和参数另写一行,这样可以使方法和参数更易读。 public
CounterSet(int size){
this.size = size;
} 克隆方法
如果这个类是可以被克隆的,那么下一步就是 clone 方法: 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());
}
} 类方法
下面开始写类的方法: /**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void 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 same size");
System.arraycopy(r1, 0, r3, 0, r1.length);
System.arraycopy(r2, 0, r4, 0, r1.length);
}
toString 方法
无论如何,每一个类都应该定义 toString 方法: public
String toString() {
String retval = "CounterSet: ";
for (int i = 0; i < data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
} main 方法
如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.
Java中呢?
C++:TClass *lpObject = new TClass();
Java中呢?至少没有p得概念吧
我看到Java程序,包括书中得程序都没有命名规范,到处得变量名字根本不能一幕了然看出类型来,觉得特别不爽。到底有没有命名规范啊