求java的命名规则....谁知提供一下呗.. 我以后想当一名有良好的编程习惯的程序员..所以想学学命名规则.谁能提供一下谢谢... for example比如一些对象名称的前缀command 可以简写cmd .. merci~
解决方案 »
- java中怎样实现这个侧边隐藏的控件呢?
- 熟悉hibernate search 的请进
- 求:swing hacks电子书
- 在JAVA中如何用数组实现把日期转换为星期几
- 谁有水晶报表java实现的例子或者学习文档,最好是中文的
- 谢谢~关于Thread.currentThread.destory()的问题
- Method是String类型,值是一个函数的方法名,如何实现这个方法的调用?
- 每日一问,JAVAC如何显示报错的信息为中文
- 每天忙忙绿绿,几年来只有无法有质的飞跃,如何是好?
- byte类型的数据如何转化成二进制数,显示给用户(如8-》0000 1000)
- 怎么把java的程序弄成双击可以运行的.
- 关于数据库树型结构设计问题!请大家给点意见。
ClassName
methodName
fieldName
PDF 版:http://developers.sun.com/software/sundev/whitepapers/java-style.pdf
这是一个 Sun 关于 Java 代码格式的小册子,只有 20 来页
规则是本像模像样的书上都有,规范则比较灵活,总结几条仅供参考:
1. 所有名字尽量使用英文单词或词组,别图省事使用汉语拼音,拼音命名是新手的做法。
2. 单词缩写以惯用为主,不一定非得拘泥于死规矩,最典型的属 I18N 和 L10N 了。
3. 一般命名采用驼峰标识法,即词组梅个单词首字符要大写。
4. Java中的约定如下:
包名无论词组还是词组缩写一律全小写,例如 java.io,java.awt,net.sagazk.project 等。
类名首字符大写,一般是名词或名词词组,例如 YourClass,Tester,DbManager 等。
接口名同类名,另外形容词也可以,用来表示一种能力,例如 Cloneable,Runnable 等。
实例域名首字符大写,一般是名词或名词词组。
常量(public static final 修饰的)名所有字符全大写,用下划线分割单词,例如 GAME_MODE,MAX_VALUE 等。
方法名首字符小写,一般是动词或动词词组,例如 show,loadConfig 等。
形参变量同实例域。
局部变量(方法内声明的变量)一般没有上面的要求严格,但基本的要求是见名知意。
剩下的楼下补充。
1、包名:xxxyyyzzz
2、类名、接口名:XxxYyyZzz
2、方法名、变量名:xxxYyyZzz
4、常量名:XXXYYYZZZ
希望对你有所帮助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[]) 方法已经定义了, 那么它应该写在类的底部. 代码编写格式
代码样式
代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行)
文档化
必须用 javadoc 来为类生成文档。不仅因为它是标准,这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的,因为代码不应该是被个人拥有的。
缩进
缩进应该是每行2个空格. 不要在源文件中保存Tab字符. 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.
如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格,然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。
页宽
页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.
{} 对
{} 中的语句应该单独作为一行. 例如, 下面的第1行是错误的, 第2行是正确的: if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) {
i ++
}; // 正确, { 单独作为一行
} 语句永远单独作为一行.
如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。
括号
左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用: CallProc( AParameter ); // 错误
CallProc(AParameter); // 正确 不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法: if ((I) = 42) { // 错误 - 括号毫无意义
if (I == 42) or (J == 42) then // 正确 - 的确需要括号 程序编写规范
exit()
exit 除了在 main 中可以被调用外,其他的地方不应该调用。因为这样做不给任何代码代码机会来截获退出。一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退出。
异常
申明的错误应该抛出一个RuntimeException或者派生的异常。
顶层的main()函数应该截获所有的异常,并且打印(或者记录在日志中)在屏幕上。
垃圾收集
JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问题:你必须在使用完对象的实例以后进行清场工作。比如一个prel的程序员可能这么写: ...
{
FileOutputStream fos = new FileOutputStream(projectFile);
project.save(fos, "IDE Project File");
}
...
除非输出流一出作用域就关闭,非引用计数的程序语言,比如JAVA,是不能自动完成变量的清场工作的。必须象下面一样写: FileOutputStream fos = new FileOutputStream(projectFile);
project.save(fos, "IDE Project File");
fos.close(); Clone
下面是一种有用的方法: implements Cloneable public
Object clone()
{
try {
ThisClass obj = (ThisClass)super.clone();
obj.field1 = (int[])field1.clone();
obj.field2 = field2;
return obj;
} catch(CloneNotSupportedException e) {
throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());
}
} final 类
绝对不要因为性能的原因将类定义为 final 的(除非程序的框架要求)
如果一个类还没有准备好被继承,最好在类文档中注明,而不要将她定义为 final 的。这是因为没有人可以保证会不会由于什么原因需要继承她。
访问类的成员变量
大部分的类成员变量应该定义为 protected 的来防止继承类使用他们。
注意,要用"int[] packets",而不是"int packets[]",后一种永远也不要用。 public void setPackets(int[] packets) { this.packets = packets; } CounterSet(int size)
{
this.size = size;
}