Wetts's blog

Stay Hungry, Stay Foolish.

0%

Java-命名规范

  1. JAVA源文件的命名:JAVA源文件名必须和源文件中所定义的类的类名相同。

  2. Package的命名:Package名的第一部分应是小写ASCII字符,并且是顶级域名之一,通常是com、edu、gov、mil、net、org或由ISO标准3166、1981定义的国家唯一标志码。Package名的后续部分由各组织内部命名规则决定,内部命名规则指定了各组件的目录名,所属部门名、项目名等。它们全都是 小写字母

  3. Class/Interface的命名:Class名应是首字母大写,通常以 名词 结尾。命名时应该使其简洁而又具有描述性。而且在类名中要体现它是以保存数据为主还是提供功能为主。例如 ConnectionBuilder 这个类我们都可以猜到它的主要功能是创建 Connection 对象。异常类的命名,应以Exception结尾。Interface的命名规则与Class相同。

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

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

  • 以动词-er/or 结尾的类名,至少应该包含一个以该动词开头的方法。例如 ConnectionBuilder 这个类,它至少应该包含一个以 build- 开头的方法。有了这种默契,别人就能更方便的使用这个类。

  1. 常量的命名:常量名的字母应全部大写,不同的单词之间通过 下划线 进行连接,并且名字组合应该赋予含义。

  2. 变量的命名

  • 普通变量:普通变量名的首字母小写,其它每个单词的首字母大写。命名时应该使其简短而又有特定含义,简洁明了的向使用者展示其使用意图。

  • 约定变量:所谓约定变量,是指那些使用后即可抛弃(throwaway)的临时变量。通常i、j、k、m和n代表整型变量;c、d和e代表字符型变量。

  1. 方法的命名:方法名的第一个单词应是 动词,并且首字母小写,其它每个单词首字母大写。
  • 类的获取方法(一般具有返回值):一般要求被方法名使用被访问字段名,前面加上前缀get,例如getFirstName(), getLastName()。

  • 类的布尔型的判断方法:一般要求方法名使用单词 is 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals。

    • 检查某个属性是否为空或者某条记录是否存在的方法,通常命名为 hasXXX(),例如 hasResult()。
    • 检查对象状态的方法通常以 is+形容词 命名。例如 isClosed(),isReady()
  • 类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,例如setFirstName(),setLastName(),setWarpSpeed()

  • 类的普通方法:一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的 动词,第一个字母小写,例如 openFile(), addAccount()。

  • 增删改查方法的命名:

    以对 Person 类的增删改查为例:

    • 创建一个 Person对象的方法一般命名为 createPerson()/newPerson(),
    • 添加方法命名为 addPerson(),修改方法命名为 updatePerson(),
    • 删除方法命名为 deletePerson()/removePerson(),
    • 根据主键查询的方法命名为 getPerson()/queryPerson()。
    • 根据其他条件来查询,要指出具体的条件类型,例如 getPersonByName() 或 getPersonByAge()。

    方法的名称要统一。例如一开始用的是 deleteXXX 而不是 removeXXX,那么整个项目都应该这样用下去。

  • 计数方法:通常命名为 getNumberOfXXX()/getXXXCount()。例如 getNumberOfRows(),getQuestionCount()。

  1. 方法参数的命名:应该选择有意义的名称作为方法的参数名。如果可能的话,选择和需要赋值的字段一样的名字。