登录
首页 >  文章 >  java教程

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

来源:dev.to

时间:2024-11-01 14:01:07 436浏览 收藏

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

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

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删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>