Java教程

编程时常用命名规则

本文主要是介绍编程时常用命名规则,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!

常见命名规则以及适用场景

这里介绍 4 种最常见的命名规范

一、驼峰命名法(CamelCase)

驼峰命名法应该我们最常见的一个,种命名方式使用大小写混合的格式来区别各个单词,并且单词之间不使用空格隔开或者连接字符连接的命名方式。

1.大驼峰命名法(CamelCase)

通常类名需要使用大驼峰命名法

正例:

ServiceDiscovery、ServiceInstance、LruCacheFactory

反例:

serviceDiscovery、Serviceinstance、LRUCacheFactory

2.小驼峰命名法(lowerCamelCase)

通常函数方法名、参数名、成员变量、局部变量需要使用小驼峰命名法
正例:

getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat)
Uservice userService;

反例:

GetUserInfo()、CreateCustomThreadPool()、setNameFormat(String NameFormat)
Uservice user_service

3.蛇形命名法(snake_case)

通常测试方法名、常量、枚举名称需要使用蛇形命名法
在蛇形命名法中,各个单词之间通过下划线“_”连接,比如

should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE

蛇形命名法的优势是命名所需要的单词比较多的时候,比如我把上面的命名通过小驼峰命名法给大家看一下:“shouldGet200StatusCodoWhenRequestIsValid”。感觉如何? 相比于使用蛇形命名法(snake_case)来说是不是不那么易读?
正例:

@Test
void should_get_200_status_code_when_request_is_valid() {
  ......
}

反例:

@Test
void shouldGet200StatusCodoWhenRequestIsValid() {
  ......
}

4.串式命名法(kebab-case)

在串式命名法中,各个单词之间通过下划线“-”连接
建议项目文件夹名称使用串式命名法


总结

1.通常类名需要使用大驼峰命名法
2.通常函数方法名、参数名、成员变量、局部变量需要使用小驼峰命名法
3.通常测试方法名、常量、枚举名称需要使用蛇形命名法
4.项目文件夹名称可以使用串式命名法

欢迎大家扫码关注本人公众号:编程复盘与思考随笔

(关注后可以免费获得本人在csdn发布的资源源码)

公众号主要记录编程和刷题时的总结复盘笔记和心得!并且分享读书、工作、生活中的一些思考感悟!

在这里插入图片描述

这篇关于编程时常用命名规则的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!