c++(Qt)编码规范.

### C++ (Qt) 编码规范详解 #### 一、引言 良好的编码规范能够显著提升代码的质量，包括但不限于可读性和可维护性。在软件开发过程中，尤其是在团队协作中，一致性的编码规范尤为重要。它有助于团队成员之间更好地理解和共享代码，减少因个人习惯差异而产生的混乱，从而加速开发流程并降低维护成本。本篇文档基于C++及Qt的特性，综合考虑了C++编程规范和Java编程规范的优点，旨在为Qt开发人员提供一份实用且易于遵循的编码指南。 #### 二、重要惯例 ##### 1. 变量命名规则 - **变量或函数名的区分**：通过在变量名或函数名中使用大写字母来区分各部分，便于记忆和阅读。 - **Qt类库变量命名**：对于Qt类库中的特定类型变量，通常采用将类名中的大写字母提取出来并转换为小写的缩写形式（忽略第一个字母“Q”）。例如： - `QLineEdit* m_leInputNum;` - `QString* m_sName;` 如果出现两个类名缩写相同的冲突情况（如`QToolBar`和`QToolButton`），应适当调整其中一个类名的缩写形式，以确保清晰无误地表达类的含义。例如，可以将`QToolBar`的缩写改为`tbar`，而`QToolButton`保持为`tb`。 - **自定义对象类型命名**：自定义对象类型的变量命名遵循与Qt类库变量相同的方法。 - **局部变量**：局部变量应选择常见且具有描述性的名称，如`num`、`nCount`、`i`、`j`、`k`、`n`、`len`、`pos`、`offset`、`nReadNum`、`index`、`nRet`、`ret`、`string`、`filename`等。 - **临时变量**：临时变量命名可以使用类似`ltmp`、`ftmp`、`tmpStr`、`tempStr`这样的形式。 - **自定义信号和槽**：自定义信号以`sig_`开头，自定义槽以`slt_`开头。首字母采用小写，之后的每个单词首字母大写。例如：`sig_mouseClicked()`、`slt_getMouseEvent()`。此外，信号和槽之间的参数应完全对应。 - **函数命名**：获取自定义私有变量值的函数以`Get`开头（如`GetLength()`），设置私有变量值的函数以`Set`开头（如`SetLength()`）。全局函数命名推荐以小写`g`开头。 - **避免使用缩写**：Qt建议尽量避免使用缩写，即便像`previous`缩写为`prev`这样常见的形式，也应避免使用，以减少记忆负担。 - **类名命名**：类名应以大写字母开头，以字母`Q`开头表示该类属于Qt软件包。自定义类可以以大写字母`A`开头，且第二字母也应大写。 - **函数命名**：函数名以小写字母开头，最好是一个动词或包含动词的短语，如`collidesWithItem()`。 ##### 2. 工程中目录的使用 - **图片文件**：所有图片文件统一保存在`./pics/`目录中，建议使用JPEG或PNG格式。 - **汉化文件**：工程使用的汉化相关文件（`.po`和`.qm`）放置于`./i18n/`目录。 - **临时交换目录**：定义为宏形式，如`./temp/`，避免使用固定的目录名，例如`./tmp/`（该目录名在某些Qt for Windows版本中有特殊意义）。 ##### 3. 工程文件命名原则 - **工程文件命名**：工程文件（`.pro`）命名采用“工程名+`.pro`”的方式。例如，对于一个名为`AChart`的工程项目，其工程文件命名为`AChart.pro`。 - **多文件管理**：在pro文件中的`HEADERS`和`SOURCES`行中，如果有多个文件名，建议按逻辑分组并合理命名，以方便管理和查找。 #### 三、总结 本篇文档提供了C++ (Qt) 开发中的一些重要惯例，涵盖了变量命名、目录结构以及文件命名等方面的具体指导。遵循这些规范不仅能够提升代码质量，还能增强团队协作效率。对于从事Qt开发的工程师来说，掌握并运用这些规范至关重要。希望本篇文档能帮助开发者们编写出既高效又易于维护的代码。