代码命名规范指引

在编写代码时，选择合适的命名是至关重要的。一个好的命名能够清晰地表达变量、函数、类等的意图和功能，从而提高代码的可读性和可维护性。本文将为您提供一套全面的代码命名规范指引，帮助您编写出高质量的代码。

一、工程名

工程名不强制统一，可以根据项目特点和团队习惯来命名。但是，为了方便管理和协作，建议遵循以下规则：

1. 工程名应简短明了，能够清晰地表达项目的核心功能或特点；
2. 工程名应避免使用下划线或美元符号等特殊字符；
3. 工程名应使用小写字母，避免使用大写字母或数字开头。

二、文件名

文件名应该基于工程名，并遵循以下规则：

1. 文件名开头3个字母应表明与哪一个工程相关；
2. 文件名应能够区别不同的功能，不区分大小写；
3. 文件名长度不限于8.3格式，但建议不多于30个字符；
4. 若文件用于定义和实现类，建议文件名与类名保持一致。

三、函数名

函数名应该清晰反映函数的功能和用途，遵循以下规则：

1. 函数名应参照Windows API的命名规范，推荐使用动宾结构；
2. 函数名应明确、简洁，不使用缩写或拼写错误的单词；
3. 函数名第一个字母必须大写，全局函数必须以小写前缀“g”开头；
4. 函数名最长不得超过30个字符。

四、变量名

变量名的命名应遵循匈牙利记法，即前缀+类型+变量名。具体规则如下：

1. 前缀：表示变量的作用域和类型，比如m表示成员变量，s表示局部变量，g_表示全局变量；
2. 类型：表示变量的数据类型，比如int、char、float等；
3. 变量名：表示变量的具体名称，应该简洁明了，能够清晰地表达变量的含义。

五、常量命名

常量命名应全部大写，单词间用下划线隔开，力求语义表达完整清楚。常数名称应该简短明了，能够清晰地表达常量的含义。

六、类名命名

类名命名应使用驼峰命名法（UpperCamelCase），即首字母大写的驼峰形式。类名应该简短明了，能够清晰地表达类的核心功能或特点。抽象类命名可以使用Abstract或Base开头，异常类命名可以使用Exception结尾。

七、方法名、参数名和成员变量命名

方法名、参数名和成员变量命名应统一使用小驼峰命名法（lowerCamelCase），即除首字母外，其他字母均为小写的驼峰形式。方法名、参数名和成员变量名应该明确、简洁，能够清晰地表达其用途和含义。在需要描述参数的多个单词时，应该尽量将它们放在一起。

八、包名命名

包名统一使用小写字母，点分隔符之间有且仅有一个自然语义的英语单词。包名的选择应该基于项目的模块和组织结构，能够清晰地划分不同模块和功能的代码。包名应该避免使用缩写或拼写错误的单词。

九、运算符和空格使用

任何二目、三目运算符的左右两边都需要加一个空格。这样可以提高代码的可读性。同时，建议在运算符前后使用空格进行排版，使代码更易读懂。例如：int a = 10 + 20 30 / 40; 可以改为 int a = 10 + 20 30 / 40;。