### Clang-Format 配置项及其含义 #### 1. **AlignConsecutiveMacros** 此参数控制是否对齐连续的宏定义。当设置为 `AcrossEmptyLinesAndComments` 时，即使存在空行或注释，Clang-Format 也会对齐宏定义[^1]。 #### 2. **AlignTrailingComments** 此参数决定尾随注释（即行末注释）是否与代码对齐。将此参数设置为 `true` 可确保注释与代码正确对齐[^1]。 #### 3. **SpacesBeforeTrailingComments** 指定尾随注释前的空格数。例如，设置为 `1` 将在注释前插入一个空格[^1]。 #### 4. **MaxEmptyLinesToKeep** 控制代码中允许的最大连续空行数。例如，设置为 `1` 可以避免过多的空行。 #### 5. **ColumnLimit** 限制每行的最大字符数。超过该值的行将被自动换行[^1]。 #### 6. **IndentWidth** 指定缩进宽度。例如，设置为 `4` 表示每个缩进层级使用 4 个空格。 --- ### 示例配置文件 以下是一个 `.clang-format` 文件的示例配置，用于保持常量定义和注释的对齐： ```yaml --- AlignConsecutiveMacros: AcrossEmptyLinesAndComments AlignTrailingComments: true SpacesBeforeTrailingComments: 1 MaxEmptyLinesToKeep: 1 IndentWidth: 4 ColumnLimit: 80 ... ``` --- ### 应用配置 假设需要保持以下代码片段的格式： ```c const static int IKV_ALGORITHM_OK = 0x00000000; ///< \~chinese 正常 \~english OK const static int IKV_E_UNKNOWN = 0x10000001; ///< \~chinese 未知错误 \~english Unknown error const static int IKV_E_NOENOUGH_BUF = 0x10000002; ///< \~chinese 内存不足 \~english Insufficient memory prepared const static int IKV_E_PARAM_NOSUPPORT = 0x10000003; ///< \~chinese 不支持的参数 \~english Not supported function ``` 通过上述配置，Clang-Format 将能够自动对齐常量定义和注释，并保留代码风格[^1]。 --- ### 注意事项 - 如果项目中有多个不同的代码风格需求，可以使用不同的 `.clang-format` 文件，并通过命令行指定配置文件路径。 - 确保安装的 Clang 版本支持这些参数。部分旧版本可能不支持某些高级功能。 ---