A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 金鑫 中级黑马   /  2012-6-3 19:21  /  2023 人查看  /  0 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

一、 Java命名的一般规范
1. 类名首字母应该大写。属性(成员变量)、方法、对象变量以及所有标识符(如形式参数、实际参数、局部变量)的首字母应小写,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
例如:类名:ThisIsAClassName  属性或方法名:thisIsMethodOrFieldName  对象变量:thisIsAClassVariable

2. Java 包(Package)属于一种特殊情况,它们全都是小写字母,即便中间的单词亦是如此。对于全局包,将你的 Internet 域名反转并接上包名。
例如:cn.edu.usst.dingyuewei.package
另外,package 行要在import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。
例如:
package hotlava.net.stats;
import java.io.*;
import java.util.Observable;
import hotlava.util.Application;
这里 java.io.* 是用来代替InputStream and OutputStream 的。

3. 接口(Interface):采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able,ible 或者 er。
例如:Contactable,Prompter。

4. 组件(Component)使用完整的英文描述来说明组件的用途,末端应接上组件类型。例如:okButton,customerList,fileMenu。

5. 类中常用方法的命名:
(1). 类的获取方法(一般具有返回值)一般要求被方法名使用被访问字段名,前面加上前缀get,如: getFirstName(), getLastName()。
(2). 类的布尔型的判断方法一般要求方法名使用单词 is 做前缀,如: isPersistent(),isString()。或者使用具有逻辑意义的单词,例如: equal 或: equals
(3). 类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如: setFirstName(),setLastName(),setWarpSpeed()。
(4). 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的动词,第一个字母小写,如; openFile(), addAccount()。
(5). 构造方法应该用递增的方式写(比如:参数多的写在后面)。
例如:
public CounterSet(){}
public CounterSet(int size){ this.size = size;}
(6). toString 方法:一般情况下,每一个类都应该定义toString 方法,其格式为:
public String toString() {…}
(7). 一般应考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。

6. 静态常量字段(static final)一般全部采用大写字母,单词之间用下划线分隔(也有特例,如Java 类库中关于颜色的常数没有严格地全部使用大写字母)。如MIN_BALANCE,
DEFAULT_DATE。

7. 循环计数变量通常采用字母 i,j,k 或者 counter。而数组应该总是用下面的方式来命名:objectType[] 或 byte[] buffer。


二、 Java注释
1. 类的整体注释:遵循JavaDoc的规范,在每一个源文件的开头注明该CLASS的作用, 作简要说明, 并写上源文件的作者, 编写日期。如果是修改别人编写的源文件,要在修改
信息上注明修改者和修改日期。
例如:
/**
* @(#):CLASSNAME.java
* @description: Description of this java
* @author: PROGRAMMER'S NAME YYYY/MM/DD
* @version: Version No.
* @modify:
* @Copyright: 版权由拥有
*/

2. 类中方法的注释:遵循JavaDoc的规范,在每个方法的前部用块注释的方法描述此方法的作用,以及传入,传出参数的类型和作用,以及需要捕获的错误。
例如:
/**
* 方法的描述
*
*
*@param 参数的描述
*@return 返回类型的描述
*@exception 出错信息的描述
*/

3. 行注释:使用//…的注释方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面一行或同一行。

4. 块注释:使用/**和*/注释的方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面。

5. 注释哪些部分:类的目的(即类所完成的功能)、设置接口的目的以及应如何被使用、成员方法注释(对于设置与获取成员方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么?返回什么?)、普通成员方法内部注释(控制结构、代码做了些什么以及为什么这样做,处理顺序等)、实参和形参的含义以及其他任何约束或前提条件、字段或属性描述。而对于局部变量,如无特别意义的情况下不加注释。

评分

参与人数 2技术分 +1 黑马币 +6 收起 理由
赵志勇 + 6 很给力!
袁錦泰 + 1 非常好!

查看全部评分

0 个回复

您需要登录后才可以回帖 登录 | 加入黑马