行业资讯 2025年08月6日
0 收藏 0 点赞 715 浏览 1806 个字
摘要 :

文章目录 命名包 命名类 接口命名 命名方法 命名变量 常量命名约定 命名泛型类型 命名枚举 命名注解 Java 命名约定是应用程序程序员应遵循的准则,以便在整个应用程序……




  • 命名包
  • 命名类
  • 接口命名
  • 命名方法
  • 命名变量
  • 常量命名约定
  • 命名泛型类型
  • 命名枚举
  • 命名注解

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中,接口名称通常应该是形容词。接口应采用标题格式,每个单词的第一个字母大写。在某些情况下,当接口呈现一系列类时,接口也可以是名词,比如:ListMap

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 中代码编写一致时应遵循的命名约定,这使得代码更具可读性和可维护性。

在使用任何编程语言编写干净的代码时,命名约定可能是首先要遵循的最佳实践。

归属教程 Java基础教程

文章目录 前言  第1章 Java语言基础 第2章 流程控制语句 第3章 面向对象编程 第4章 Java 字符 […]

微信扫一扫

支付宝扫一扫

版权: 转载请注明出处:https://www.zuozi.net/8976.html

管理员

相关推荐
2025-08-06

文章目录 一、Reader 接口概述 1.1 什么是 Reader 接口? 1.2 Reader 与 InputStream 的区别 1.3 …

988
2025-08-06

文章目录 一、事件溯源 (一)核心概念 (二)Kafka与Golang的优势 (三)完整代码实现 二、命令…

465
2025-08-06

文章目录 一、证明GC期间执行native函数的线程仍在运行 二、native线程操作Java对象的影响及处理方…

348
2025-08-06

文章目录 一、事务基础概念 二、MyBatis事务管理机制 (一)JDBC原生事务管理(JdbcTransaction)…

456
2025-08-06

文章目录 一、SnowFlake算法核心原理 二、SnowFlake算法工作流程详解 三、SnowFlake算法的Java代码…

517
2025-08-06

文章目录 一、本地Jar包的加载操作 二、本地Class的加载方法 三、远程Jar包的加载方式 你知道Groo…

832
发表评论
暂无评论

还没有评论呢,快来抢沙发~

助力内容变现

将您的收入提升到一个新的水平

点击联系客服

在线时间:08:00-23:00

客服QQ

122325244

客服电话

400-888-8888

客服邮箱

122325244@qq.com

扫描二维码

关注微信客服号