background image

        1

 

、包(

Package )的命名

            Package 的名字应该采用完整的英文描述符,都是由一个小写单词组
成。并且包名的前缀总是一个顶级域名,
            

 

通常是

com、edu、gov、mil、net、org 等;

            

 

如:

com.yjhmily.test

        2

 

、类(

Class )的命名

            类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大
写。尽量保证类名简洁而富于描述。
            

 

使用完整单词,避免缩写词

( 除非工程内有统一缩写规范或该缩写词

 

被更广泛使用,像

URL   

HTML)

            

 

如:

FileDescription

        3

 

、接口(

Interface )的命名

            

 

基本与

Class 

 

的命名规范类似。在满足

Classd 命名规则的基础之上,

 ”

保证开头第一个字母为

I”,

            

 

便于与普通的

Class 区别开。其实现类名称取接口名的第二个字母到最

后,且满足类名的命名规范;
        

 

如:

IMenuEngine

        4

 

、枚举(

Enum )的命名

            

 

基本与

Class 

 

的命名规范类似。在满足

Classd 命名规则的基础之上,

 ”

保证开头第一个字母为

E” ,

            

 

便于与普通的

Class 区别开。

        

 

如:

EUserRole

        5

 

、异常(

Exception )的命名

            

 

异常(

Exception   

 

) 通常采用字母

e 表示异常,对于自定义的异常

 

类,其后缀必须为

Exception

        

 

如:

BusinessException

        6

 

、方法(

Method )的命名

            方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小
写,其后单词的首字母大写。
            

 

方法名尽可能的描述出该方法的动作行为。返回类型为

Boolean 值的

“ 

方法一般由

is ” “ 

has ”来开头

        

 

如:

getCurrentUser()   

addUser()   

hasAuthority()

        7

 

、参数(

Param )的命名

            第一个单词的首字母小写,其后单词的首字母大写。参数量名不允许以
下划线或美元符号开头,
            虽然这在语法上是允许的。参数名应简短且富于描述。
        

 

如:

public UserContext getLoginUser(String loginName);