Java 代码规范[持续更新中]

Java 代码规范

1. Java 命名约定

  类名、接口名的第一个字母要大写。

1.1 通常概念

  * 尽可能使用完整的英文描述符

  * 采用适用于相关领域的术语

  * 采用大小写混合使名字可读

  * 尽可能少用缩写,但若是用了,最好加上注释便于理解

  * 避免使用太长的名字

  * 避免使用相似的名字,或者仅仅是大小写不一样的名字


1.2 示范

  包(Package) 采用完整的英文描述符,应该都是由小写字母组成。

  类(Class) 采用完整的英文描述符,全部单词的第一个字母大写。 如:
      Person     Car

  接口(Interface) 采用完整的英文描述符说明接口封装,全部单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。如:
      Contactable   Prompter

  组件/部件(Component) 使用完整的英文描述来讲明组件的用途,末端应接上组件类型。 如:
      okButton
      fileMenu

  异常(Exception) 一般采用字母 e 表示异常。

  获取成员函数 被访问字段名的前面加上前缀 get。函数

                如:getFirstName(), getLastName()

       布尔型的获取成员函数 全部的布尔型获取函数必须用单词 is 作前缀。spa

                 如: isPersistent(), isString()

    设置成员函数 被访问字段名的前面加上前缀 set。代码规范

                        setFirstName(), setLastName(),setWarpSpeed()

    普通成员函数 采用完整的英文描述说明成员函数功能,第一个单词尽量采用动词,第一个字母小写。接口

                        openFile(), addAccount()

     静态常量字段(static final) 所有采用大写字母,单词之间用下划线分隔。get

                   MIN_BALANCE, DEFAULT_DATE
    
     循环计数器 一般采用字母 i,j,k 或者 counter 均可以接受。 i, j, k, counter



8.8.8其余经常使用公司规范:io

 (1)常量通常放在前面,变量放在后面,如:if("abc"==str)      null!=x等等写法,table

            目的是为了防止笔误遗漏符号写成  str="abc"     x=null。ast

相关文章
相关标签/搜索