java文档和编码规范,java编码规范文档

.

可编辑范本！Java代码规范

1. 标识符命名规范

1.1 简洁

简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。

1.2 英文vs 拼音

尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole则不好，用guiDang 尚可接受。

1.3 包名

使用小写字母如com.xxx.settlment，不要com.xxx.Settlement

单词间不要用字符隔开，比如com.xxx.settlment.jsfutil，而不要com.xxx.settlement.jsf_util

1.4 类名

1.4.1 首字母大写

类名要首字母大写，比如SupplierService, PaymentOrderAction；不要supplierService, paymentOrderAction.

1.5 方法名

首字母小写，如addOrder() 不要AddOrder()

动词在前，如addOrder()，不要orderAdd()

名称不要太长

动词前缀往往表达特定的含义，如下表：