如何制定有效的命名规范以增强代码的可读性与维护性？

1、匈牙利命名法

|定义 |特点 |示例 |

| | | |

| 匈牙利命名法是一种早期的命名规范，由微软的一个匈牙利人发明，该规范要求前缀字母用变量类型的缩写，其余部分用变量的英文或英文的缩写，单词第一个字母大写。int iMyAge;、char cMyName[10];、float fManHeight;。

2、驼峰式命名法

|定义 |特点 |示例 |

| | | |

| 驼峰式命名法包括小驼峰式和大驼峰式（帕斯卡命名法），小驼峰式要求第一个单词首字母小写，后面其他单词首字母大写；大驼峰式要求每个单词的第一个字母都要大写。int myAge;、char myName[10];、float manHeight;。

3、下划线命名法

|定义 |特点 |示例 |

| | | |

| 下划线命名法通过下划线来分割全部都是大写的单词，尤其在宏定义和常量中使用较多。int my_age;、char my_name[10];、float man_height;。

4、通用命名规则

|定义 |特点 |示例 |

| | | |

| 描述性命名，少用缩写，函数、变量、文件名要有描述性，尽量使用描述性的命名，避免只有项目开发者能理解的缩写。bsp_i2c.h、bsp_i2c.c。

5、类型命名

|定义 |特点 |示例 |

| | | |

| 类型名称的每个单词首字母均大写，不包含下划线，所有类型命名（类、结构体、类型定义、枚举、类型模板参数）均使用相同约定。MyExcitingClass、MyExcitingEnum。

6、变量命名

|定义 |特点 |示例 |

| | | |

| 变量名一律小写，单词之间用下划线连接，类的成员变量以下划线结尾，但结构体的不用。a_local_variable、a_struct_data_member、a_class_data_member_。

7、文件命名

|定义 |特点 |示例 |

| | | |

| 文件名尽量全部小写，可以包含下划线或连字符，依照项目的约定。bsp_i2c.c、bspi2c.c。

8、路径命名规则

|定义 |特点 |示例 |

| | | |

| 全部采用小写代码，使用名词，不适用动词。data/datasets/raw、models/trained_models。

9、高可读命名规范

|定义 |特点 |示例 |

| | | |

| 提高代码的可读性，命名应具有描述性，避免模糊不清的命名。daysSinceModification、isFileChanged。

10、重构原则

|定义 |特点 |示例 |

| | | |

| 全局修改所有引用处，避免有全局变量的影响，每一处小小的优化都是对代码质量的提升，将不规范的命名修改为规范的命名。

FAQs

1、为什么需要重视命名？

原因：好的命名即是注释，别人一看到你的命名就知道你的变量、方法或者类是做什么的，这样可以减少不必要的注释，提高代码的可读性和可维护性。

2、常见的命名规范有哪些？

匈牙利命名法：前缀字母表示变量类型，其余部分用变量的英文或英文缩写，单词第一个字母大写。

驼峰式命名法：包括小驼峰式和大驼峰式（帕斯卡命名法），前者第一个单词首字母小写，后者每个单词的第一个字母都要大写。

下划线命名法：通过下划线来分割全部都是大写的单词，尤其在宏定义和常量中使用较多。

通用命名规则：描述性命名，少用缩写，函数、变量、文件名要有描述性。

类型命名：类型名称的每个单词首字母均大写，不包含下划线。

变量命名：变量名一律小写，单词之间用下划线连接，类的成员变量以下划线结尾，但结构体的不用。

文件命名：文件名尽量全部小写，可以包含下划线或连字符，依照项目的约定。

路径命名规则：全部采用小写代码，使用名词，不适用动词。

高可读命名规范：提高代码的可读性，命名应具有描述性，避免模糊不清的命名。

重构原则：全局修改所有引用处，避免有全局变量的影响，每一处小小的优化都是对代码质量的提升。