316 字
2 分钟
常见命名范式
现代项目常见命名范式
我相信不少萌新在接触完整项目时,会发现在代码中各个元素的命名都是有规律、成体系的。它们有规律,而且很简单。
规范范式的命名很重要,在社区/商企的实际项目中,遵循统一的命名规范可以极大地提高代码的可读性和可维护性。“统一度量衡” ,这是连秦始皇都明白的道理。只有组成的零部件在互通上不成障碍,才能加速主干部分的发展。
不同的命名法有各自的特点和常见的应用场景,通常在不同的编程语言或代码元素(如变量、函数、类)中会有所偏好,下表将对此大致介绍。
| 命名规范 | 格式 | 主要应用对象 | 常用语言/场景 | 示例 |
|---|---|---|---|---|
| lowerCamelCase | myVariableName | 变量、函数、方法 | Java, JavaScript, C#, C++ | userName, calculateTotal, getUserInfo |
| UpperCamelCase | MyClassName | 类、接口、组件、构造函数 | Java, C#, Python, JavaScript (用于类) | UserProfile, ServiceManager, HttpRequest |
| snake_case | my_variable_name | 变量、函数、文件名、数据库字段 | Python, Ruby, C/C++ 标准库, SQL | user_name, calculate_total, first_name |
| SCREAMING_SNAKE_CASE | MY_CONSTANT_NAME | 常量、全局配置 | Java, Python, PHP 等多种语言 | MAX_CONNECTIONS, API_KEY, DEFAULT_TIMEOUT |
| kebab-case | my-variable-name | CSS 类名、HTML 属性、URL 路径、文件名 | CSS, HTML, Lisp | main-container, user-profile-card, primary-button |