Skip to content

Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sunrisepeak merged 6 commits into from
Mar 10, 2026
Merged

Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c22b91c
docs: Add docs for clang-format and clang-tidy
FrozenLemonTee Mar 10, 2026
82c80c9
docs: Add docs for clang-format and clang-tidy to readme
FrozenLemonTee Mar 10, 2026
3628b3b
docs: Fix doc format
FrozenLemonTee Mar 10, 2026
a128472
docs: Remove redundant spaces
FrozenLemonTee Mar 10, 2026
f3be806
docs: fix brace and control-statement parenthesis spacing; update .cl…
FrozenLemonTee Mar 10, 2026
0b76ff8
Update clang-tidy.md to remove space
FrozenLemonTee Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .clang-format
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ColumnLimit: 100 # Maximum line width
# -----------------------------------------------------------------------------
# Spaces
# -----------------------------------------------------------------------------
SpaceBeforeParens: Never # No space before function call parentheses
SpaceBeforeParens: ControlStatements # Space before parentheses for control statements (if/for/while); function calls remain tight
SpacesInContainerLiterals: true # Enforce spaces in container literals
SpaceBeforeAssignmentOperators: true # Add space before assignment operators
SpacesInParentheses: false # No extra spaces inside parentheses
Expand Down
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ xlings install mcpp:clang-format

## 目录

- 一、`标识符`命名风格
- 一、标识符命名风格
- 1.0 [类型名 - 大驼峰](./README.md#10-类型名---大驼峰)
- 1.1 [对象/数据成员 - 小驼峰](./README.md#11-对象数据成员---小驼峰)
- 1.2 [函数 - 下划线(snake_case)](./README.md#12-函数---下划线snake_case)
Expand All @@ -68,10 +68,13 @@ xlings install mcpp:clang-format
- 3.3 [用 std::string_view 替代 char*](./README.md#33-用-stdstring_view-替代-char)
- 3.4 [用 optional/expected 替代 int 错误码](./README.md#34-用-optionalexpected-替代-int-错误码)
- 3.5 [RAII 资源管理](./README.md#35-raii-资源管理)
- 四、配置文件
- 4.0 [Clang-Format 配置](./clang-format.md)
- 4.1 [Clang-Tidy 配置](./clang-tidy.md)

## 一、`标识符`命名风格
## 一、标识符命名风格

> 核心思想通过`标识符`风格设计, 能快速识别 - 类型、函数、数据以及封装性
> 核心思想通过**标识符**风格设计, 能快速识别 - 类型、函数、数据以及封装性

下方示例综合展示各小节要点:

Expand Down Expand Up @@ -795,6 +798,13 @@ struct AutoLog {
};
```

## 四、配置文件

本章包含两个常用工具的配置说明：`clang-format`（代码格式化）和 `clang-tidy`（静态检查）。详细文档见：

- [Clang-Format 配置](./clang-format.md) — 代码格式化规则与示例。
- [Clang-Tidy 配置](./clang-tidy.md) — 静态检查规则集合与示例。

---

## 相关链接
Expand Down
Loading