变量命名规则

本文最后更新于:2022年12月12日 晚上

本文记录编程常用的几种命名规范及其应用场景。

大驼峰命名法(CamelCase)

  • 又称 **帕斯卡 (Pascal Case)**命名法

  • 所有单词首字母大写,直接连接排列

  • 类名通常使用 大驼峰命名法

  • 示例:

1
ServiceDiscovery、ServiceInstance、LruCacheFactory

小驼峰命名法(lowerCamelCase)

  • 首单词首字母小写,之后的单词首字母大写,单词直接连接
  • 通常函数方法名、参数名、成员变量、局部变量需要使用小驼峰命名法
  • 示例:
1
2
getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat)
Uservice userService;

蛇形命名法(snake_case)

  • 单词所有字母小写(方法、变量名)或大写(枚举、宏),单词间用下划线_连接

  • 通常测试方法名、常量、枚举名称需要使用蛇形命名法

  • 示例:

1
should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE

单词数量多时更具可读性

有时会结合驼峰命名法,变为 驼峰蛇形命名法~

匈牙利命名法(HN case)

  • 遵循:属性 + 类型 + 描述 的方式为变量命名,使得程序员对变量类型和属性有直观了解
  • 示例:
1
2
pfnEatApple   	//pfn 是类型描述, EatApple 是对象描述
g_cch //g_ 是属性描述,表示全局变量,cch 表示计数类型是字符类型,表示变量类型

串式命名法(kebab-case)

  • 又名脊柱命名法(Spinal case)

  • 各个单词之间通过横杠 - 连接

  • 建议项目文件夹名称使用串式命名法

  • 示例:

1
training-data

参考资料


变量命名规则
https://www.zywvvd.com/notes/coding/utils/naming-para/naming-para/
作者
Yiwei Zhang
发布于
2022年12月12日
许可协议