docs: 修复了贡献文档,重新对 README 排版
This commit is contained in:
@@ -75,18 +75,16 @@
|
||||
|
||||
## 🎨 代码风格
|
||||
|
||||
- 使用 **C++17** 标准。
|
||||
- 缩进统一为 **4 空格**。
|
||||
- 文件名统一小写,单词用下划线分隔(如 `event_loop.h`)。
|
||||
- 类名采用 **大驼峰命名**(如 `EventLoop`)。
|
||||
- 函数与变量采用 **小写加下划线**(如 `start_server()`,`buffer_size`)。
|
||||
- 公共接口需要写清楚 **Doxygen 风格注释**。
|
||||
详见 [代码规范](code_style.md)
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Code Review 原则
|
||||
|
||||
详见 [代码规范](code_style.md)
|
||||
- 确认代码可读、可维护,避免冗余实现。
|
||||
- 注意异常处理、内存管理和线程安全问题。
|
||||
- 保证接口一致性和合理性。
|
||||
- 审查通过后,才能合并到 `dev` 分支。
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user