开发设计规范要素.docx

技术开发规范［初稿］北京中科天擎信息技术有限公司2016年11月12日JAVA代码规范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 简洁简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetS