Skip to content

Commit 82c80c9

Browse files
docs: Add docs for clang-format and clang-tidy to readme
1 parent c22b91c commit 82c80c9

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ xlings install mcpp:clang-format
6868
- 3.3 [用 std::string_view 替代 char*](./README.md#33-用-stdstring_view-替代-char)
6969
- 3.4 [用 optional/expected 替代 int 错误码](./README.md#34-用-optionalexpected-替代-int-错误码)
7070
- 3.5 [RAII 资源管理](./README.md#35-raii-资源管理)
71+
- 四、配置文件
72+
- 4.0 [Clang-Format 配置](./clang-format.md)
73+
- 4.1 [Clang-Tidy 配置](./clang-tidy.md)
7174

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

@@ -793,6 +796,13 @@ struct AutoLog {
793796
explicit AutoLog(std::string_view n) : name { n } { std::println("{} 开始", name); }
794797
~AutoLog() { std::println("{} 结束", name); }
795798
};
799+
800+
## 四、配置文件
801+
802+
本章包含两个常用工具的配置说明:`clang-format`(代码格式化)和 `clang-tidy`(静态检查)。详细文档见:
803+
804+
- [Clang-Format 配置](./clang-format.md) — 代码格式化规则与示例。
805+
- [Clang-Tidy 配置](./clang-tidy.md) — 静态检查规则集合与示例。
796806
```
797807

798808
---

0 commit comments

Comments
 (0)