《JAVA代码规范》（七）命名规范 (3.1-3.6)
3 命名规范
3.1 总则
凡在精联公司内进行开发的任何软件项目的命名，无论是项目名称、文件名、数据库名、表名、 字段名、SQL存贮过程名、变量名、函数名、类名、组件名，均应符合以下规定：
l 名称全部由下划线、英文字母和数字组成
l 在以下情况下可以在名称中出现数字：
n 用于命名版本(项目版本、文件版本、函数版本等)
n 用于临时性的小程序(如演示程序、测试程序、编程学习程序等)的变量命名
n 因特殊原因两个对象(指项目、文件、数据库等)一定要具有相同的英文名称时
l 如果系统限制名称长度(如某些数据库管理系统中表的命名)低于32位字符，则以系统限制为标准；否则任何对象(指项目、文件、数据库等)的名称均不得超过32个字符(命名文件时扩展名不计)
l 除以下情况外，名称全部应由有意义的英文单词（当英文单词很难表达时，可以变通采用汉字拼音）组成，并且不超过5个英文单词
n Word文档的命名
n 命名数据库、表、字段名时用到的开头特定字符(mc_)
n 临时性项目(如演示程序、测试程序、编程学习程序等)
3.2 项目命名
一般来说，项目名称有两个含义。一是该项目的通用名，如“合理用药系统”，主要用于公司内部交流，它可以是中文也可以是英文，且不受本规范的限制；二是该项目在开发人员进行代码管理时用的英文缩写名，如“PASS”，它用于项目在计算机上的管理。此处主要讨论后一种命名。
l 项目名称由该项目的负责人指定
l 项目名称用于以下场合：
n 如命名Visual Source Safe项目名
n 命名该项目在开发人员本地计算机的工作文件夹名
n 命名WSAD的.ear文件名
n 命名用于保存、拷贝、压缩、电邮传递等场合的文件夹名或文件名
一般情况下项目名不应含版本信息，如遇特殊情况，由可考虑用数字和下划线的方式来指定版本。如PASS_2_0表示PASS 2.0版。
规范的项目名称如：
项目通用名称：健康信息管理系统
项目名称：PIMS
Visual Source Safe项目名：PIMS
该项目各开发人员在本地计算机上的工作文件夹名：PIMS
WSAD项目文件名：PIMS
如导出该项目压缩成一个文件可能名称为：PIMS.ear
3.3 命名规则
命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。
| 标识符类型 | 命名规则 | 例子 |
| 包(Packages) | 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。 | com.apple.quicktime.v2 edu.cmu.cs.bovik.cheese |
| 类(Classes) | 命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML) | Class Raster; class ImageSprite; |
| 接口(Interfaces) | 命名规则：大小写规则与类名相似 | interface RasterDelegate; |
| 方法(Methods) | 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 | run(); |
| 变量(Variables) | 除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。 | char c; int i; float myWidth; |
| 实例变量(Instance Variables) | 大小写规则和变量名相似，除了前面需要一个下划线 | int _employeeId; String _name; Customer _customer; |
| 常量(Constants) | 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误) | static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; static final int GET_THE_CPU = 1; |
3.4 变量命名机制
3.4.1 基本类型变量命名规则：变量类型标识+逻辑名
l 变量类型标识用于标识该变量所存储的数据类型，小写字母开头。
l 逻辑名为变量所具有的表示具体应用含义的名称，要做到见名知意，书写时要以字母开头，首字母大写
基本变量类型标识 定义如下：
Type Prefix
-------------------
short s
int i/n
char c/ch
double d
boolean b
long l
float f
3.4.2 一般常用对象命名规则
以下为一些常用对象前缀。如果有些对象不在以下表格中，请将该对象类名小写做为前缀。
常用对象前缀 如下：
Type Prefix Type Prefix
Short short Boolean boolean
Integer int Long long
Char char Float flt
Object obj String str
Date dt Event event
Demenstion obj Size size
Color clr Context ctx
Connection conn RecordSet rs
Statement stmt Command cmd
Window wnd Frame frame
Dialog dlg File file
Button btn Socket skt
Image img InputStream ins
OutputStream outs PrintStream ps
Request request/resq Response response/resp
Double dbl
例如：
int nCount;
long lLength;
Object objResult;
String strUserName;
Frame frameMain;
3.4.3 临时变量命名规则
一般临时变量没有一个具体的意思，所以一般临时变量名为Temp或Tmp。其中有一些为C语言 或Fortan延续下来的常见临时变量也可以接受：如i ，j ，k 一般用于表示一个临时整型变量。
如：int nTemp ,I
String strTemp
Boolean bTmp
long lTem
3.4.4 全局变量、成员变量、局部变量命名规则
l 局部变量：指在一个程序模块中声明使用的变量，该类变量使用3.3中定义的命名规则(以后称一般命名)。
l 全局变量：一般为多个模块公有，所以在命名区别于局部变量，要在一般命名的变量名前加上前缀：g_
如：int g_nUserCount
l 成员变量：是指类成员变量，用于表示类的一种或一类属性。要在一般命名的变量名前加上前缀：m_
如： String m_strName
3.4.5 常量命名机制
在Java中常量名一般为大写，单词之间用_分隔。
如： public static final int MAX_USER_COUNT = 100 ;
3.5 HTML 元素变量命名机制
l form name：frmFormName
l hidden，text：首字母大写，不用下划线。
如：ClientID， OrderID，UserName，Passwd，etc
l button，submit：btnButtonName
如：
<form name=”frmSearch”>
<input type=”Hidden” name=”ClientID”>
<input type=”Text” name=”OrderID”>
<input type=”Button” name=”btnSubmit”>
</form>
3.6 JSP 文件命名机制
JSP 文件命名方式：首字母大写,不用下划线。
如：OrderSearch.jsp
ClientMng.jsp
版权：《JAVA代码规范》是我以前在学校跟同学、老师一起编写的，参考了一些网上资料，有少部分内容可能会有相同。本文仅在ajava.org发布，各位转载必须注明出处。-苦力工
正文到此结束
热门推荐
相关文章
Loading...
![[HBLOG]公众号](http://www.liuhaihua.cn/img/qrcode_gzh.jpg)
