Java开发规范之命名篇(上)

本文详细介绍了Java开发的命名规范,包括阿里巴巴和Google的Java编程规范。内容涵盖类名、方法名、变量名、常量名、包名等的命名规则,旨在提高代码可读性和维护性。例如,类名使用UpperCamelCase风格,方法名和变量名使用lowerCamelCase风格,常量全大写,包名全小写。同时,文章提醒开发者避免拼音与英文混合命名,以及子父类、局部变量的重名问题。
摘要由CSDN通过智能技术生成

阿里巴巴早在2017年就推出了《Java开发手册》,旨在规范Java开发人员在开发过程中的编码,这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。

为了让开发者更加方便、快速的将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件, 该插件在扫描代码后,将不符合手册规范的代码显示在界面中。我们可以在IDEA中选择 Preferences - Plugins - Browse repositories ,输入框中输入"alibaba",选择"Alibaba Java Coding Guidelines"进行安装,重启IDEA后即可使用。

Google也在2016年推出了《Java编程规范》,它是Google公司对Java编程风格规范的完整定义,主要内容包含编码格式是否美观的问题, 同时也讨论一些约定及编码标准。国内已经有人将其翻译为中文,具体请参考 Google《Java编程规范》中文版 ,另外如果需要PDF文档可以在 这里 去下载 。另外在Eclipse IDE和 IntelliJ IDE可以导入代码风格配置文件,可以方便使用该编码规范,请点击 传送门,具体方法是依次点击 Window -> Preferences -> Java -> Code Style -> Formatter -> Import,导入下载文件后即可使用。

本系列文章将结合两个《Java规范》进行总结,通过具体编码案例给出编码规范的原因,如果总结内容存在问题还望指出。


目录

1. 类名开始和结尾

2.拼音与英文混合命名

3.UpperCamelCase风格命名

4.lowerCamelCase风格命名

5.常量名命名

6.特殊类命名前缀和后缀

7.类型和括号位置

8.POJO类变量禁止命名方式

9.包名命名方式

10.变量重名


本篇文章总结的内容是Java开发规范的命名规范,主要涉及Java的类、方法、变量和包名等命名规范,对应阿里巴巴的Java开发手册的第一章第一节命名风格和谷歌Java开发手册第五章命名,该规范只是作为建议,具体实施过程可以根据场景变动。

1. 类名开始和结尾

【阿里巴巴】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

【Google】标识符只能使用ASCII字母和数字,因此每个有效的标识符名称都能匹配正则表达式 \w+ 。

说明:虽然Java命名没有强制定义命名的字符,但是如果命名规范对后期代码阅读和维护有很大帮助。

反例:

【阿里巴巴】_name / __name /

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值