mirror of
https://github.com/78/xiaozhi-esp32.git
synced 2026-02-27 14:26:36 +00:00
Add clang-format (#1694)
-文件.clang-format配置基于Google C++风格指南，并做了适当调整 1.使用4空格缩进 2.行宽限制为100字符 3.采用风格的大括号和空格规则 -编写code_style.m 1.针对不同开发平台（windows/Linux/macOs） 2.举例进行整体项目格式化（建议owner择机进行） 3.举例单文件格式化、格式检查 4.举例如何跳过特定代码段的格式化（待补充指定跳过文件格式化） 5.IDE集成说明 Co-authored-by: CaptainBarker <1350989027@qq.com>
This commit is contained in:
Wang is proud
126
.clang-format
Normal file
126
.clang-format
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
---
|
||||||
|
Language: Cpp
|
||||||
|
BasedOnStyle: Google
|
||||||
|
AccessModifierOffset: -4
|
||||||
|
AlignAfterOpenBracket: Align
|
||||||
|
AlignConsecutiveAssignments: false
|
||||||
|
AlignConsecutiveDeclarations: false
|
||||||
|
AlignEscapedNewlines: Left
|
||||||
|
AlignOperands: true
|
||||||
|
AlignTrailingComments: true
|
||||||
|
AllowAllParametersOfDeclarationOnNextLine: true
|
||||||
|
AllowShortBlocksOnASingleLine: false
|
||||||
|
AllowShortCaseLabelsOnASingleLine: false
|
||||||
|
AllowShortFunctionsOnASingleLine: All
|
||||||
|
AllowShortIfStatementsOnASingleLine: false
|
||||||
|
AllowShortLoopsOnASingleLine: false
|
||||||
|
AlwaysBreakAfterReturnType: ExceptShortType
|
||||||
|
AlwaysBreakBeforeMultilineStrings: true
|
||||||
|
AlwaysBreakTemplateDeclarations: Yes
|
||||||
|
BinPackArguments: true
|
||||||
|
BinPackParameters: true
|
||||||
|
BraceWrapping:
|
||||||
|
AfterClass: false
|
||||||
|
AfterControlStatement: false
|
||||||
|
AfterEnum: false
|
||||||
|
AfterFunction: false
|
||||||
|
AfterNamespace: false
|
||||||
|
AfterObjCDeclaration: false
|
||||||
|
AfterStruct: false
|
||||||
|
AfterUnion: false
|
||||||
|
AfterExternBlock: false
|
||||||
|
BeforeCatch: false
|
||||||
|
BeforeElse: false
|
||||||
|
IndentBraces: false
|
||||||
|
SplitEmptyFunction: false
|
||||||
|
SplitEmptyRecord: false
|
||||||
|
SplitEmptyNamespace: false
|
||||||
|
BreakBeforeBinaryOperators: None
|
||||||
|
BreakBeforeBraces: Attach
|
||||||
|
BreakBeforeInheritanceComma: false
|
||||||
|
BreakInheritanceList: BeforeColon
|
||||||
|
BreakBeforeTernaryOperators: true
|
||||||
|
BreakConstructorInitializersBeforeComma: false
|
||||||
|
BreakConstructorInitializers: BeforeColon
|
||||||
|
BreakAfterJavaFieldAnnotations: false
|
||||||
|
BreakStringLiterals: true
|
||||||
|
ColumnLimit: 100
|
||||||
|
CommentPragmas: '^ IWYU pragma:'
|
||||||
|
CompactNamespaces: false
|
||||||
|
ConstructorInitializerAllOnOneLineOrOnePerLine: true
|
||||||
|
ConstructorInitializerIndentWidth: 4
|
||||||
|
ContinuationIndentWidth: 4
|
||||||
|
Cpp11BracedListStyle: true
|
||||||
|
DerivePointerAlignment: false
|
||||||
|
DisableFormat: false
|
||||||
|
ExperimentalAutoDetectBinPacking: false
|
||||||
|
FixNamespaceComments: true
|
||||||
|
ForEachMacros:
|
||||||
|
- cJSON_ArrayForEach
|
||||||
|
IncludeBlocks: Preserve
|
||||||
|
IncludeCategories:
|
||||||
|
- Regex: '^<esp_.*\.h>'
|
||||||
|
Priority: 1
|
||||||
|
- Regex: '^<driver/.*\.h>'
|
||||||
|
Priority: 1
|
||||||
|
- Regex: '^<.*\.h>'
|
||||||
|
Priority: 2
|
||||||
|
- Regex: '^<.*'
|
||||||
|
Priority: 3
|
||||||
|
- Regex: '.*'
|
||||||
|
Priority: 4
|
||||||
|
IncludeIsMainRegex: '([-_](test|unittest))?$'
|
||||||
|
IndentCaseLabels: true
|
||||||
|
IndentPPDirectives: None
|
||||||
|
IndentWidth: 4
|
||||||
|
IndentWrappedFunctionNames: false
|
||||||
|
KeepEmptyLinesAtTheStartOfBlocks: false
|
||||||
|
MacroBlockBegin: ''
|
||||||
|
MacroBlockEnd: ''
|
||||||
|
MaxEmptyLinesToKeep: 1
|
||||||
|
NamespaceIndentation: None
|
||||||
|
PenaltyBreakAssignment: 2
|
||||||
|
PenaltyBreakBeforeFirstCallParameter: 1
|
||||||
|
PenaltyBreakComment: 300
|
||||||
|
PenaltyBreakFirstLessLess: 120
|
||||||
|
PenaltyBreakString: 1000
|
||||||
|
PenaltyBreakTemplateDeclaration: 10
|
||||||
|
PenaltyExcessCharacter: 1000000
|
||||||
|
PenaltyReturnTypeOnItsOwnLine: 200
|
||||||
|
PointerAlignment: Left
|
||||||
|
RawStringFormats:
|
||||||
|
- Language: Cpp
|
||||||
|
Delimiters:
|
||||||
|
- cc
|
||||||
|
- CC
|
||||||
|
- cpp
|
||||||
|
- Cpp
|
||||||
|
- CPP
|
||||||
|
- 'c++'
|
||||||
|
- 'C++'
|
||||||
|
CanonicalDelimiter: ''
|
||||||
|
BasedOnStyle: google
|
||||||
|
ReflowComments: true
|
||||||
|
SortIncludes: true
|
||||||
|
SortUsingDeclarations: true
|
||||||
|
SpaceAfterCStyleCast: false
|
||||||
|
SpaceAfterTemplateKeyword: true
|
||||||
|
SpaceBeforeAssignmentOperators: true
|
||||||
|
SpaceBeforeCpp11BracedList: false
|
||||||
|
SpaceBeforeCtorInitializerColon: true
|
||||||
|
SpaceBeforeInheritanceColon: true
|
||||||
|
SpaceBeforeParens: ControlStatements
|
||||||
|
SpaceBeforeRangeBasedForLoopColon: true
|
||||||
|
SpaceInEmptyParentheses: false
|
||||||
|
SpacesBeforeTrailingComments: 2
|
||||||
|
SpacesInAngles: false
|
||||||
|
SpacesInContainerLiterals: true
|
||||||
|
SpacesInCStyleCastParentheses: false
|
||||||
|
SpacesInParentheses: false
|
||||||
|
SpacesInSquareBrackets: false
|
||||||
|
Standard: Latest
|
||||||
|
StatementMacros:
|
||||||
|
- Q_UNUSED
|
||||||
|
- QT_REQUIRE_VERSION
|
||||||
|
TabWidth: 4
|
||||||
|
UseTab: Never
|
||||||
91
docs/code_style.md
Normal file
91
docs/code_style.md
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
# 代码风格指南
|
||||||
|
|
||||||
|
## 代码格式化工具
|
||||||
|
|
||||||
|
本项目使用 clang-format 工具来统一代码风格。我们已经在项目根目录下提供了 `.clang-format` 配置文件，该配置基于 Google C++ 风格指南，并做了一些自定义调整。
|
||||||
|
|
||||||
|
### 安装 clang-format
|
||||||
|
|
||||||
|
在使用之前，请确保你已经安装了 clang-format 工具：
|
||||||
|
|
||||||
|
- **Windows**：
|
||||||
|
```powershell
|
||||||
|
winget install LLVM
|
||||||
|
# 或者使用 Chocolatey
|
||||||
|
choco install llvm
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Linux**：
|
||||||
|
```bash
|
||||||
|
sudo apt install clang-format # Ubuntu/Debian
|
||||||
|
sudo dnf install clang-tools-extra # Fedora
|
||||||
|
```
|
||||||
|
|
||||||
|
- **macOS**：
|
||||||
|
```bash
|
||||||
|
brew install clang-format
|
||||||
|
```
|
||||||
|
|
||||||
|
### 使用方法
|
||||||
|
|
||||||
|
1. **格式化单个文件**：
|
||||||
|
```bash
|
||||||
|
clang-format -i path/to/your/file.cpp
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **格式化整个项目**：
|
||||||
|
```bash
|
||||||
|
# 在项目根目录下执行
|
||||||
|
find main -iname *.h -o -iname *.cc | xargs clang-format -i
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **在提交代码前检查格式**：
|
||||||
|
```bash
|
||||||
|
# 检查文件格式是否符合规范（不修改文件）
|
||||||
|
clang-format --dry-run -Werror path/to/your/file.cpp
|
||||||
|
```
|
||||||
|
|
||||||
|
### IDE 集成
|
||||||
|
|
||||||
|
- **Visual Studio Code**：
|
||||||
|
1. 安装 C/C++ 扩展
|
||||||
|
2. 在设置中启用 `C_Cpp.formatting` 为 `clang-format`
|
||||||
|
3. 可以设置保存时自动格式化：`editor.formatOnSave: true`
|
||||||
|
|
||||||
|
- **CLion**：
|
||||||
|
1. 在设置中选择 `Editor > Code Style > C/C++`
|
||||||
|
2. 将 `Formatter` 设置为 `clang-format`
|
||||||
|
3. 选择使用项目中的 `.clang-format` 配置文件
|
||||||
|
|
||||||
|
### 主要格式规则
|
||||||
|
|
||||||
|
- 缩进使用 4 个空格
|
||||||
|
- 行宽限制为 100 字符
|
||||||
|
- 大括号采用 Attach 风格（与控制语句在同一行）
|
||||||
|
- 指针和引用符号靠左对齐
|
||||||
|
- 自动排序头文件包含
|
||||||
|
- 类访问修饰符缩进为 -4 空格
|
||||||
|
|
||||||
|
### 注意事项
|
||||||
|
|
||||||
|
1. 提交代码前请确保代码已经过格式化
|
||||||
|
2. 不要手动调整已格式化的代码对齐
|
||||||
|
3. 如果某段代码不希望被格式化，可以使用以下注释包围：
|
||||||
|
```cpp
|
||||||
|
// clang-format off
|
||||||
|
// 你的代码
|
||||||
|
// clang-format on
|
||||||
|
```
|
||||||
|
|
||||||
|
### 常见问题
|
||||||
|
|
||||||
|
1. **格式化失败**：
|
||||||
|
- 检查 clang-format 版本是否过低
|
||||||
|
- 确认文件编码为 UTF-8
|
||||||
|
- 验证 .clang-format 文件语法是否正确
|
||||||
|
|
||||||
|
2. **与期望格式不符**：
|
||||||
|
- 检查是否使用了项目根目录下的 .clang-format 配置
|
||||||
|
- 确认没有其他位置的 .clang-format 文件被优先使用
|
||||||
|
|
||||||
|
如有任何问题或建议，欢迎提出 issue 或 pull request。
|
||||||
Reference in New Issue
Block a user