Java编码规范指南:命名风格、代码格式、OOP规约等

需积分: 4 2 下载量 57 浏览量 更新于2024-07-17 收藏 435KB DOCX 举报
Java 编码规范 Java 编码规范是 Java 语言编程的基本准则,旨在提高代码的可读性、可维护性和可扩展性。以下是 Java 编码规范的详细说明: 一、命名风格 * 代码中的命名不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 * 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 * 类名使用 UpperCamelCase 风格,但以下情形例外:DO/BO/DTO/VO/AO/PO 等。 * 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵循驼峰形式。 * 变量和常量的命名方式: + 非公有(private/protected/default)变量前面要加上小写 m + 静态变量(static)前面加上小写 s + 其它变量以小写字母开头 + 静态常量(static final)全大写 二、常量定义 * 常量命名全部大写,单词键用下划线隔开,力求语义表达完整,不要嫌名字长。 三、代码格式 * 抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类名开始,以 Test 结尾。 * 类型与中括号紧挨相连来定义数组。 四、OOP 规约 * POJO 类中布尔类型的标量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。 五、集合处理 * 集合处理需要遵循 Java 集合框架的规则,确保代码的可读性和可维护性。 六、并发处理 * 并发处理需要遵循 Java 并发编程的规则,确保代码的线程安全和可扩展性。 七、控制语句 * 控制语句需要遵循 Java 控制语句的规则,确保代码的可读性和可维护性。 八、注释规约 * 注释规约需要遵循 Java 注释的规则,确保代码的可读性和可维护性。 遵循 Java 编码规范可以提高代码的质量和可维护性,提高开发效率和代码重用性。