1,为什么编码规范这么重要
编码规范非常重要,因为他们会形成你自己或你小组成员代码的一致性。巨大的一致使得代码容易理解,这样反过来意味着代码更容易开发和维护。这些都会减少你建立的应用系统的整体开销。
你要记住,在你转入下一个项目后的很长时间内你的Java代码会一直存在。开发中的一个重要目标,就是保证你能把你的工作转交给其他的开发者,或者另一个组内的开发者,以便他们能继续维护和提高你的工作,而不是必须投入不合理的努力去理解你的代码。
难于理解的代码经常存在重写的风险。
2,基本原则
没有标准是完美的,也没有标准会适合任何情况。有时,你会发现自己处于一个或多个标准都不能适用的处境。
这就是必须提到的编码规范指导原则:尽可能去遵循良好的编码规范,当你必须去违背规范时,以文字的形式进行注释。
3,Java命名规范
除开特殊情况的少数例外,你应该总是使用英文进行命名,而且在通常情况下使用小写字母,但是对于类名的第一个字母、接口名首字母以及各个不位于最前出现的词的首字母要大写。
一般的规范概念:
1)全部使用英语描述符
2)使用领域相关的术语
3)大小写混合命名增加可读性
4)避免使用长名字(尽量少于15个字母)
5)避免两个相似的名字或者只是在大小写上不同
| 项目 | 命名规范 | 示例 |
| 参数 | 带有描述性的词,可以加上a或者an的前缀 | customer, account, |
| 属性/成员变量 | 第一个词的首字母小写,后几个词的首字母大写 | firstName, lastName, warpSpeed |
| boolean型的getter方法 | 前缀为is | isPersistent(), isString(), isCharacter() |
| 类 | 所有词的首字母都要大写 | Customer, SavingsAccount |
| 组件 | 描述词 + 组件类型 | okButton, customerList, fileMenu |
| 异常 | 一般用e表示 | e |
| final static型变量 | 全部用大写,以下划线隔开 | MIN_BALANCE, DEFAULT_DATE |
| getter方法 | 加上前缀get | getFirstName() |
| 循环变量 | 一般使用i,j,k或者counter | i,j,k,counter |
| 成员函数 | 首字母小写,第一词尽量用动词 | openFile(), addAccount() |
| setter方法 | 前缀为set | setFirstName() |




