Java
代码规范
1.
标识符命名规?/p>
1.1
概述
标识符的命名力求做到统一?/p>
达意和简洁?/p>
尽量做到每个人按照规范来?/p>
多人开发如一人开
发一样?/p>
1.1.1
统一
统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用
supplier
?/p>
也可以用
provider
?/p>
但是我们只能选定一个使用,
至少在一?/p>
Java
项目中保持统
一。统一是作为重要的?/p>
如果对同一概念有不同的表示方法?/p>
会使代码混乱难以理解?/p>
即使
不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一次?/p>
1.1.2
达意
达意是指,标识符能准确的表达出它所代表的意义,比如?/p>
newSupplier,
OrderPaymentGatewayService
等;?/p>
supplier1, service2
?/p>
idtts
等则不是好的命名方式?/p>
准确有两成含义,一是正确,而是丰富。如果给一个代表供应商的变量起名是
order
,显?/p>
没有正确表达。同样的?/p>
supplier1,
远没?/p>
targetSupplier
意义丰富?/p>
1.1.3
简?/p>
简洁是指,在统一和达意的前提下,用尽量少的标识符。如果不能达意,宁愿不要简洁。比
如:
theOrderNameOfTheTargetSupplierWhichIsTransfered
太长?/p>
transferedTargetSupplierOrderName
则较好,但是
transTgtSplOrdNm
就不好了。省略元
音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写?/p>
1.1.4
骆驼法则
Java
中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词?/p>
间不使用特殊符号分割,而是通过首字母大写来分割。比?/p>
: supplierName,
addNewContract
,而不?/p>
supplier_name, add_new_contract
?/p>
1.1.5
英文
vs
拼音