章
目
录
Java 命名约定是应用程序程序员应遵循的准则,以便在整个应用程序中生成一致且可读的代码。如果团队不遵循这些约定,他们可能会共同编写难以阅读和难以理解的应用程序代码。
Java大量使用驼峰大小写符号来命名方法,变量等。以及类和接口的 TitleCase 表示法。
让我们通过示例详细了解这些命名约定。
命名包
包名称必须是一组以全小写域名开头的单词(例如 com、org、net 等)。根据组织自己的内部命名约定,包名称的后续部分可能会有所不同。
package com.panziye.webapp.controller;
package com.company.myapplication.web.controller;
package com.google.search.common;
命名类
在 Java 中,类名通常应该是名词,首字母大写,每个单词的第一个字母大写。例如
public class ArrayList {}
public class Employee {}
public class Record {}
public class Identity {}
接口命名
在Java中,接口名称通常应该是形容词。接口应采用标题格式,每个单词的第一个字母大写。在某些情况下,当接口呈现一系列类时,接口也可以是名词,比如:List
和Map
public interface Serializable {}
public interface Clonable {}
public interface Iterable {}
public interface List {}
命名方法
方法始终应该是动词。它们代表操作,方法名称应清楚地说明它们执行的操作。方法名称可以是单个单词,也可以是 2-3 个单词,以清楚地表示操作。单词应采用驼峰式大小写表示法。
public Long getId() {}
public void remove(Object o) {}
public Object update(Object o) {}
public Report getReportById(Long id) {}
public Report getReportByName(String name) {}
命名变量
所有实例、静态和方法参数变量名称都应采用驼峰式大小写表示法。它们应该简短并足以描述其目的。临时变量可以是单个字符,例如循环中的计数器。
public Long id;
public EmployeeDao employeeDao;
private Properties properties;
for (int i = 0; i < list.size(); i++) {
}
常量命名约定
Java 常量应全部大写,其中单词之间用下划线字符(“_”)分隔。确保对常量变量使用Final修饰符。
public final String SECURITY_TOKEN = "...";
public final int INITIAL_SIZE = 16;
public final Integer MAX_SIZE = Integer.MAX;
命名泛型类型
泛型类型参数名称应为大写单字母。'T'
通常建议使用类型字母。在 JDK 类中,E
用于集合元素、S
用于服务加载器以及K and V
用于映射键和值。
public interface Map <K,V> {}
public interface List<E> extends Collection<E> {}
Iterator<E> iterator() {}
命名枚举
与类常量类似,枚举名称应全部大写字母。
enum Direction {NORTH, EAST, SOUTH, WEST}
命名注解
注释名称遵循标题大小写表示法。根据需要,它们可以是形容词、动词或名词。
public @interface FunctionalInterface {}
public @interface Deprecated {}
public @interface Documented {}
public @Async Documented {
public @Test Documented {}
在这篇文章中,我们讨论了Java 中代码编写一致时应遵循的命名约定,这使得代码更具可读性和可维护性。
在使用任何编程语言编写干净的代码时,命名约定可能是首先要遵循的最佳实践。
文章目录前言 第1章 Java语言基础 第2章 流程控制语句 第3章 面向对象编程 第4章 Java 字符串 […]