公司定制的Java编码规范

"JAVA代码规范详细版" 在Java编程中，遵循一定的代码规范至关重要，因为它有助于提高代码的可读性、可维护性和团队协作效率。这份文档基于SUN的Java代码规范，并根据公司实际需求进行了适当的调整。以下是一些关键的Java代码规范要点： **1. 标识符命名规范** 1.1 概述 - **统一**：确保在代码中对相同概念的表示保持一致。例如，对于“供应商”，应选择并坚持使用“supplier”或“provider”，避免混合使用。 - **达意**：标识符应清晰地反映其代表的含义。例如，“newSupplier”和“OrderPaymentGatewayService”是好的命名，而“supplier1”和“service2”则不够明确。 - **简洁**：在不影响理解和一致性的前提下，尽可能减少字符数量。过于冗长的名称应避免，但也不能牺牲表达准确性。例如，避免使用“theOrderNameOfTheTargetSupplierWhichIsTransfered”，可以简化为“transferedTargetSupplierOrderName”。 1.1.4 **骆驼法则（CamelCase）** Java中的标识符通常遵循骆驼法则，即将每个单词的首字母大写，如“supplierName”和“addNewContract”。这不适用于包名和静态常量，它们通常是全小写。 1.1.5 **英文与拼音** 优先使用易于理解的英文单词，若遇到困难，可以寻求团队成员的帮助。如果必须使用汉语拼音，应避免与英文混用。例如，使用“archive”表示“归档”，避免使用“pigeonhole”，而“guiDang”可以接受地表示“归档”。 **2. 包名** 包名应全部使用小写字母，如“com.xxx.settl”。包名通常按照反向域名的方式组织，以便在全球范围内避免命名冲突。 **3. 类与接口** - 类名应使用名词，如“Customer”、“Order”。 - 接口名通常以“I”开头，如“IUserService”。 **4. 变量命名** - 实例变量首字母小写，如“customerName”。 - 局部变量和参数首字母小写，如“localVariable”。 - 常量全大写，单词间用下划线分隔，如“MAX_SIZE”。 **5. 方法命名** - 方法名应使用动词，描述其行为，如“calculateTotal”、“saveUser”。 **6. 注释** - 使用Javadoc为类、方法和变量提供文档注释。 - 单行注释使用“//”，多行注释使用“/* */”。 **7. 缩进与空格** - 使用4个空格进行缩进，避免使用制表符。 - 在括号内、操作符周围、方法调用的参数之间添加空格。 **8. 空行** - 类的定义之间、方法之间的空行用于区分逻辑段落。 **9. 异常处理** - 使用具体异常类，避免使用通用的“Exception”。 **10. 类设计** - 遵循单一职责原则，每个类只做一件事情。 - 尽可能使类和方法私有化，仅公开必要的接口。 以上只是部分Java代码规范的要点，完整的规范还包括更多的细节，如导入管理、代码布局、注释风格等。在实践中，应结合SUN的Java标准代码规范和公司内部的具体要求来编写和审查代码。这样可以确保代码质量，降低维护成本，提升团队协作效率。