当前位置:首页 > 文章列表 > 文章 > java教程 > 项目 采用普遍接受的命名约定

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

来源:dev.to 2024-11-01 14:01:07 0浏览 收藏
推广推荐
免费电影APP ➜
支持 PC / 移动端,安全直达

最近发现不少小伙伴都对文章很感兴趣,所以今天继续给大家介绍文章相关的知识,本文《项目 采用普遍接受的命名约定》主要内容涉及到等等知识点,希望能帮到你!当然如果阅读本文时存在不同想法,可以在评论中表达,但是请勿使用过激的措辞~

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

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

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

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

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

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

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

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

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

  • 类:使用名词或名词短语(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。

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

今天关于《项目 采用普遍接受的命名约定》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
cpu用久了很卡?cpu用久了很卡?
上一篇
cpu用久了很卡?
使用 nhooyr.io/websocket 时,如何解决第三方库错误?
下一篇
使用 nhooyr.io/websocket 时,如何解决第三方库错误?
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3213次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3428次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3457次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4566次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    3833次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码