JAVA编程规约精简版

需积分: 9 0 下载量 69 浏览量 更新于2024-07-16 收藏 170KB DOCX 举报
"JAVA开发手册强制精简版本.docx" 该文档是针对Java开发者的编码规约,主要聚焦于编程规范,特别强调了命名风格、类和对象的设计以及一些其他重要的编程约定。以下是对这些规范的详细说明: 1. **命名风格**: - **下划线和美元符号的禁用**:所有命名都不应以下划线或美元符号开头或结束,以避免混淆和不规范。 - **禁止混合拼音和英文**:命名应完全使用英文,避免拼音和英文混杂,以确保清晰度和一致性。纯拼音的命名也被视为不推荐。 - **类名**:使用UpperCamelCase风格,但特殊情况下如DO/BO/DTO/VO/AO/PO/UID等除外。 - **方法名、参数名、成员变量、局部变量**:使用lowerCamelCase风格,使变量名读起来流畅。 - **常量命名**:全大写,使用下划线分隔单词,确保命名能清晰表达其含义。 - **抽象类、异常类和测试类**:抽象类以Abstract或Base开头,异常类以Exception结尾,测试类以其测试的对象名开始并以Test结尾。 - **数组表示**:使用类型后跟中括号的方式定义数组,如`int[] arrayDemo`。 - **布尔变量**:POJO类中的布尔变量不应加is前缀,因为这可能导致某些框架的序列化错误。但在数据库建表时,为表示“是否”的字段,通常使用is_xxx的方式。 2. **编程规约**: - **中括号与类型紧邻**:定义数组时,类型和中括号应紧密相连,如`int[] array`,而不应在main方法参数中使用`String args[]`的方式。 - **POJO类中的布尔变量**:由于某些框架的问题,布尔变量不应命名为is_xxx形式,否则可能引起序列化问题。在ORM映射时,可能需要在`<resultMap>`中单独配置从is_xxx到xxx的映射。 这些规则旨在提高代码的可读性、可维护性和团队间的协作效率。遵循这些规约可以确保代码的一致性和专业性,降低后期维护成本,并有助于构建高质量的Java应用程序。在实际开发中,开发者应该严格遵守这些规约,以提升整个项目的规范性和质量。