当前位置:文档之家› java命名规范

java命名规范

1. Java命名规范
1、 package 的命名格式如下:com.newland.xxxx.yyyy (xxxx 为项目简称,yyyy 为package名)
2、 尽可能给出描述性名称,不要节约空间,让别人很快理解你的代码更重要,好的命名选择如下:
int num_errors;
int num_completed_connections;
丑陋的命名使用模糊的缩写或随意的字符:
int n;
int nerr;
int n_comp_conns;
3、 类和接口的名字必须由大写字母开头而其他字母都小写的单词组成,最好用有意义的单词命名。
示例:class GetTreeInfo,class TransToXml 等。
4、 方法的命名应采用完整的英文描述符,第一个字母小写,所有中间单词的第一个字母大写。类方法名称的第一个单词常常采用一个有强烈动作色彩的动词。
示例:openAccount()
printMailingLabel()
5、 Java变量的命名通常是第1个单词小写,其他单词的首字母大写。数据类型的变量第一个字母为变量类型的缩写。如:sPassword、iCount等。
数据类型的标识的说明:
数据类型 数据类型标识 数据类型 数据类型标识
整型(int) i 浮点型(float) f
字符串型(String) s 字符型(char) c
浮点型(double) d 布尔型(boolean) b
长整型(long) l 数组(Array) a
StringBuffer sb 二维数组 aa
6、 常量字段(static final)全部采用大写字母,单词之间用下划线分隔
2. 排版与注释

1、 所有的缩进定义为4个空格,在代码中不要使用TAB 键,应该使用4个空格键代替,因为在不同的编辑器下因为TAB 设置的空格数目不一致会引起格式混乱。
2、 不允许把多条语句写在同一行。如以下情况应该避免:
示例:int i = 1; float f = 0;
3、 在文件的开始部分应该有文件的说明信息,应包含如下信息:
1) 注释
2) 作者
3) 版本信息
4) 日期
5) 修改记录
示例:
/**
* description:日志记录流,用于记录日志,可以多个文件切换
*@author xxx
*@version 0.9
*@ since 2004 年9 月11 日
* 修改记录:
* 2005 年1月6日增加切换
*/
4、 公有函数和变量都应该有注释,应按照javadoc 的规范自动生成类方法中的注释信息(包括异常)。Eclipse快捷键Alt Shift J
示例:
/**
* Validates a chess move.
* @param theFromFile file from which a piece is being moved
* @param theFromRank rank from which a piece is being moved
* @param theToFile file to which a piece is being moved
* @param theToRank rank to which a piece is being moved
* @return true if the move is valid, otherwise false
*/
boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
{
...
}
3. 函数设计
1、 某些语句经编译后产生告警,但如果你认为它是正确的,那么应通过某种手段去掉告警信息。必须打开编译器的所有告警开关对程序进行编译。
2、 exit 除了在main 中可以被调用

外,其他的地方不应该调用。因为这样做不给任何代码机会来截获退出。一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退出。
3、 位于for 循环中作为计数器值的数字常量,除了1,0 之外,不应被直接
写入代码,其他数字用常量来定义
4. 安全性与性能
1、 使用 StringBuffer 对象
说明:在处理 String 的时候要尽量使用 StringBuffer 类,StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装了起来,(以花费更多时间为代价)为开发人员提供了一个安全的接口。当我们在构造字符串的时候,我们应该用 StringBuffer 来实现大部分的工作,当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如:如果有一个字符串必须不断地在其后添加许多字符来完成构造,那么我们应该使用 StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代替 StringBuffer 对象的话,会花费许多不必要的创建和释放对象的 CPU 时间。
2、 避免太多的使用 synchronized 关键字 (线程同步)
说明:避免不必要的使用关键字 synchronized,应该在必要的时候再使用她,这是一个避免死锁的好方法。 Borland Jbulider 不喜欢 synchronized 这个关键字,如果你的断点设在这些关键字的作用域内的话,调试的时候你会发现的断点会到处乱跳,让你不知所措。除非必须,尽量不要使用。
3、 出错处理
编程中要考虑方法的各种执行情况,尽可能处理所有流程情况。在有可能出错的地方都应该采用 try/catch, 在 catch 中记录出错信息;对于通用的错误处理,可建立通用的错误处理方法,处理常见的通用的错误。
4、 避免不必要的main函数
非特殊要求必须使用main独立运行的class类不要提供main方法,因为如果有main方法则class类可直接运行,对于实际不作为独立运行的class类是存在风险的

相关主题
文本预览
相关文档 最新文档