From f6be04300f8202d7080a8ff0ac5fd64cfc2b5b20 Mon Sep 17 00:00:00 2001
From: szdytom <szdytom@qq.com>
Date: Thu, 8 Feb 2024 20:53:24 +0800
Subject: [PATCH] add coding style doc

Signed-off-by: szdytom <szdytom@qq.com>
---
 docs/coding-style.md | 56 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 docs/coding-style.md

diff --git a/docs/coding-style.md b/docs/coding-style.md
new file mode 100644
index 0000000..8e5a632
--- /dev/null
+++ b/docs/coding-style.md
@@ -0,0 +1,56 @@
+## 适用于 C++ 几条代码风格指引
+
+1. 不要在空行留下缩进字符
+
+2. 不要在嵌套的结构外层省略大括号：
+
+   ```cpp
+   // 反例
+   for (int i = 0; i < n; ++i)
+   	for (int j = 0; j < m; ++j)
+   		printf("%d", a[i][j]);
+   
+   // 正确做法
+   for (int i = 0; i < n; ++i) {
+   	for (int j = 0; j < m; ++j)
+   		printf("%d", a[i][j]);
+   }
+   ```
+
+3. 不要只在 `if-else` 的一边省略大括号：
+
+   ```cpp
+   // 反例
+   if (cond) {
+   	i += 1;
+   	j += 1;
+   } else
+   	i -= 1;
+   
+   // 正确
+   if (cond) {
+   	i += 1;
+   	j += 1;
+   } else {
+   	i -= 1;
+   }
+   ```
+
+4. 不要无理由的使用逗号表达式：
+
+   ```cpp
+   // 反例
+   w = 5, h = 5;
+   
+   // 正确做法
+   w = 5;
+   h = 5;
+   ```
+
+5. 可以考虑在提交代码前使用 `clang-format` 格式化一下，使用命令：
+
+   ```shell
+   clang-format -i xxx.cpp
+   ```
+
+   请不要格式化不是你编写的代码！