1 / 13
文档名称:

JAVA编码规范.doc

格式:doc   大小:39KB   页数:13页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

JAVA编码规范.doc

上传人:1294838662 2021/9/9 文件大小:39 KB

下载得到文件列表

JAVA编码规范.doc

相关文档

文档介绍

文档介绍:命名规范
命名要使用具有实际意义的英文单词,或者单词的缩写,不要使用单个的字母来命名一个变量,一个好的命名,几乎不用看文档就能知道该方法或者变量的意义,如同Java API,它的命名还是很值得借鉴的。
命名的一般规范:
尽量使用完整的英文描述符(除非特别必要,尽量不要使用汉语拼音缩写形式)。
采用适用于相关领域的术语(如url之类的术语,但术语必须是大家认可的)。
采用大小写混合使名字可读。
尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一,一些常用的缩写可以参考Java API 如message的缩写可以为msg。
避免使用长的名字(小于 15 个字母是个好主意)。
避免使用类似的名字,或者仅仅是大小写不同的名字。
避免使用下划线(除静态常量等)。
package 的命名
package 的名字应该都是由小写字母单词组成,,三级名称为模块名。例如:包名com.highsoft.。
Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
例如:public class ThisAClassName{}
变量的命名
对于变量的命名,要尽量达到能通过变量名知道这个变量表达的含义,变量采用小写字母开头,对于由多个单词组成的变量名,所有单词都应紧靠在一起,而且大写中间单词的首字母。对于常量(static final类型)采用如下方式命名:字母全部大写并使用下划线分隔单词(如:DB_CONFIG)。
参数的命名 
参数的名字必须和变量的命名规范一致。
数组的命名
   数组命名和变量命名类似,主要是能体现出这是一组数据。
方法的参数
使用有意义的参数命名。同时请参照“变量的命名”条目。
对于javabean中简单的set和get方法,可以使用和要赋值的字段一样的名字。
setSize(int size){
   ﻩ = size;
}
方法的命名
方法的命名遵循变量的命名,方法的名字必须用一个小写字母开头。后面的单词用大写字母开头。
特定类的命名
对于Servlet类,在对象后加后缀Servlet来命名,如:UserServlet 。
对于Applet类,在对象后加后缀Applet来命名,如:GraphApplet 。
对于JUnit和测试类,在对象后加后缀Test来命名,如UserTest。
其他的特定类命名以后将不断补充进本标准中。
注释规范
使用代码注释的目的和关键
文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);
明确指出该代码的编写思路和逻辑方法;
使阅读者注意到代码中的重要转折点;
使阅读者不必在他们的头脑中仿真运行代码的执行方法。
何时书写注释:1)请在每个if语句的前面加上注释;2)在每个switch语句的前面加上注释。与if语句一样,switch语句用于评估对程序执行产生影响的表达式。 3)在每个循环的前面加上注释。每个循环都有它的作用,许多情况下这个作用不清楚直观。
Java的注释
单行注释:// 注释一行
多行注释:/* ...... */ 注释若干行
文档注释:/** ...... */ 注释若干行,并写入 javadoc 文档 ,对共有变量、方法,使用该种注释。
说明:提供给客户程序员使用的接口、公用类要严格按照文档注释进行注释,并生成doc文档,做到客户程序员通过阅读doc来使用共有类,而不是阅读源代码来使用一个公共接口或者类。
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
注释要简单明了。
要区分两种注释的区别,一种是文档注释,是给客户程序员使用的,他们不会阅读你的源代码,因此要尽可能的提供更多的信息,让他们使用起来方便;另一种是非文档注释,是提供给代码的维护人看的,是为了给代码的维护人员看的,他们是要看到你的源代码的,因此非文档注释要简单明了。
下面是一个公用类的注释:
package ;
import ;
/**
 ﻩ* 对类的用途的描述.
ﻩ* @author Firstname Lastname(作者信息)
ﻩ* ***@date  system date (创建/修改时间)
 ﻩ* ***@see ﻩﻩ(位置)
 ﻩ*/
public class MyClass extends SomeClass {
  ﻩ/** 对公有成员变量的注释(