文档介绍：时力永联科技有限公司
文档编号:
密级:
Java编程规范
版本号:
时力永联版权所有
Copyright © Forlink Technologies Co., Ltd. All Rights Reserved
文档修订历史
版本
作者
版本变化对象
变化内容描述
审核人
批准人
批准日期
曾庆伟
创建
前言
目的
软件开发中采用统一的编程规范的目的是改善程序的可读性,方便开发人员和维护人员理解代码。同时还有助于避免某些错误的发生。
适用范围
本规范适用于公司Java 编程人员;并且每人必须遵守。否则不能达到统一规范的目的。
术语
本规范涉及的Java语言术语请参考有关Java语言规范的文献。
Java 源文件
源文件概述
。一个源文件由被空行分割而成的段落以及标识每个段落的可选注释组成。每个Java源文件要仅包含一个单一的类或接口。避免使用内部类和匿名类。每个源文件不要超过2000行,否则难以阅读。
源文件的组成
Java源文件通常依次由以下几个部分组成:
- 开头注释
- 包和引入语句
- 类、接口声明
开头注释
所有的源文件都应该在开头有一个C语言风格的注释,其中列出文件名、版本信息、日期和版权声明:
/*
* 文件名
*
* 版本信息
*
* 日期
*
* 版权声明
*/
包和引入语句
在多数Java源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。例如: package ;
import ;
类、接口声明
下表描述了类和接口声明的各个部分以及它们出现的先后次序:
 
类/接口声明的各部分
注解
1
类/接口文档注释
参见《C++、Java编程注释规范》中类的注释部分。
2
类或接口的声明
 
3
类/接口实现的注释(/**……*/)如果有必要的话
该注释应包含任何有关整个类或接口的信息,而这些信息又不适合作为类/接口文档注释。
4
类的(静态)变量
首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符),最后是私有变量。
5
实例变量
首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。
6
构造器
 
7
方法的文档注释
参见《C++、Java编程注释规范》中方法的注释部分。
8
方法
这些方法应该按功能而非作用域或访问权限分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是易于阅读和理解代码。
命名规则
标识符要由能表达该标识符含义的英语单词组成。避免使用汉字、汉语拼音或其他无意义的字符串。
标识符类型
命名规则
例子
包(Packages)
为了使包名唯一,包名的前缀应是全部小写的ASCII字母并且是一个顶级域名,,edu,gov,,org,或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目(project),机器(machine),或注册名(login names)。
类(Classes)
类名是一个名词。
采用大小写混合的方式,每个单词的首字母大写。
尽量使类名简洁且有意义。
使用完整单词,避免缩写词(除非该缩写词被更广泛使用,如URL,HTML)。
class Raster;
class ImageSprite;
接口(Interfaces)
与类名规则相同。
interface RasterDelegate;
interface Storing;
方法(Methods)
方法名是一个动词。
采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。
run();
runFast();
getBackground();
变量(Variables)
变量(包括实例变量、类变量和类常量)采用大小写混合的方式。第一个单词的首字母小写,其后单词的首字母大写。
变量名不应以下划线“_”或美元符号(“$”)开头(尽管这在语法上是允许的)。
变量名要简短、易记且能表达变量的用途。
尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i、j、k、m和n,一般用于整型;c、d、和e