Java代码规范文档
5星 · 超过95%的资源 需积分: 28 131 浏览量
2018-08-19
12:59:49
上传
评论 1
收藏 147KB DOC 举报 
产品二科
Java 代码规范
本 Java 代码规范以 SUN 的标准 Java 代码规范为基础，为适应我们公司的实际需要，可能
会做一些修改。本文档中没有说明的地方，请参看 SUN Java 标准代码规范。如果两边有
冲突，以 SUN Java 标准为准。
1. 标识符命名规范
1.1 概述
标识符的命名力求做到统一、达意和简洁。
1.1.1 统一
统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用
supplier，也可以用 provider，但是我们只能选定一个使用，至少在一个 Java 项目中保持
统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。
即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一
次。
1.1.2 达意
达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier,
OrderPaymentGatewayService 等；而 supplier1, service2，idtts 等则不是好的命名方式。
准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显
然没有正确表达。同样的，supplier1, 远没有 targetSupplier 意义丰富。
1.1.3 简洁
简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。
比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，
transferedTargetSupplierOrderName 则较好，但是 transTgtSplOrdNm 就不好了。省略元
音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。
1.1.4 骆驼法则
Java 中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之
间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName,
addNewContract，而不是 supplier_name, add_new_contract。
1.1.5 英文 vs 拼音
剩余13页未读，继续阅读
评论1
最新资源