讲师中心 微信公众号
AI工具推荐 视频效率加速

项目 采用普遍接受的命名约定

云宇酱_5257

云宇酱_5257

发布时间:2024-11-01 08:51:01

|

1207人浏览过

|

来源于dev.to

转载

项目 采用普遍接受的命名约定

Java 语言有一套完善的命名约定,有助于维护代码的可读性和组织性。这些约定在 Java 语言规范 (JLS) 中有详细记录,可以分为排版约定和语法约定。

排版约定
排版命名约定涵盖包、类、接口、方法、字段和类型变量。遵循它们有助于保持代码的一致性并避免混淆,从而使其更易于使用和维护。最佳实践包括:

  • 包和模块:它们必须是分层的,用句点分隔并由小写字母组成。在组织外部使用的包必须以域名向后开头,例如 com.google 或 org.apache。

  • 类和接口:它们必须具有 PascalCase 名称,例如 ArrayList 或 FutureTask,首选全名并避免缩写,除非被广泛接受(HttpUrl 而不是 HTTPURL)。

  • 方法和字段:以驼峰命名法命名,首字母小写,例如remove或getCapacity。常量字段(最终静态)必须用大写字母书写,单词之间用下划线分隔,例如 MAX_VALUE。

局部变量:可以使用缩写和单个字符,例如 i、sum 或索引,特别是对于循环和临时变量。

类型参数:通常是单个字母,例如 T 表示泛型类型,E 表示集合的元素类型,K 和 V 表示映射的键和值。

Apache Superset Dashboard and SQL Exploration Skill
Apache Superset Dashboard and SQL Exploration Skill

Apache Superset 是一个广泛采用的开源 BI 平台,用于 SQL 探索、图表构建和仪表板交付。当代理需要查询仓库数据、组装仪表板或使用成熟的分析界面解释指标而不是临时笔记本代码时,此技能非常有用。

下载

语法约定
语法约定根据标识符的类型而有所不同,重点是提供元素功能的清晰度:

  • 类:使用名词或名词短语(Thread、ArrayList),而实用程序类通常采用复数形式(Collections、Collectors)。

  • 接口:接口名称可以使用以“able”或“ible”结尾的名词或形容词,例如 Runnable 或 Comparable。

  • 方法:动作函数的名称是动词(append、drawImage)。布尔方法通常以 is 或 has (isEnabled, hasNext) 开头。

  • getter 和 setter:返回值的方法的名称带有名词或以 get 开头,而修改值的方法以 set 开头。示例:getAge 和 setAge。

  • 转换方法:对于类型转换,使用 toString 和 asList 等约定。静态工厂通常命名为 from、of 或 getInstance。

约定的重要性
遵守这些约定可以提高代码的可读性和一致性,使团队合作和维护变得更加容易。虽然排版约定更加严格,但语法约定具有更大的灵活性,允许程序员适应上下文和常规用法的需要。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6184

2023.10.24

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

15860

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1163

2024.02.23

java标识符合集
java标识符合集

本专题整合了java标识符相关内容,想了解更多详细内容,请阅读下面的文章。

8750

2025.06.11

c++标识符介绍
c++标识符介绍

本专题整合了c++标识符相关内容,阅读专题下面的文章了解更多详细内容。

3462

2025.08.07

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3188

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

5109

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3829

2025.12.29

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Apache Maven 官方安装指南
Apache Maven 官方安装指南

共0课时 | 0人学习

Apache Maven 官方用户中心
Apache Maven 官方用户中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn