59 lines
988 B
Markdown
59 lines
988 B
Markdown
# 项目命名规范
|
|
|
|
* 类型、结构体、枚举、Concept、类型别名：`Upper_Snake_Case`
|
|
|
|
```cpp
|
|
Scene_Base
|
|
Frame_Request_Result
|
|
Renderable_Id
|
|
```
|
|
|
|
* 函数、参数、局部变量、常量：`lower_snake_case`
|
|
|
|
```cpp
|
|
render_frame()
|
|
frame_count
|
|
default_capacity
|
|
```
|
|
|
|
* 成员变量：`lower_snake_case`
|
|
|
|
```cpp
|
|
scene
|
|
pending_exception
|
|
```
|
|
|
|
* 枚举值：`lower_snake_case`
|
|
|
|
```cpp
|
|
enum class Frame_Request_Result {
|
|
none,
|
|
cancelled,
|
|
renderer_unavailable
|
|
};
|
|
```
|
|
|
|
* 模板类型参数：`Upper_Snake_Case`
|
|
|
|
```cpp
|
|
template <class Data_Type, class Observer_Type>
|
|
```
|
|
|
|
* 命名空间：`lower_snake_case`
|
|
|
|
```cpp
|
|
namespace renderive::render_3d
|
|
```
|
|
|
|
* 文件名与主要类型一致：`Upper_Snake_Case`
|
|
|
|
```text
|
|
Scene_Base.hpp
|
|
Gpu_Completion_Service.cpp
|
|
Low_Latency_Strategy.inl
|
|
```
|
|
|
|
* 内部实现统一使用 `detail` 命名空间。
|
|
|
|
**总规则：类型大写下划线，值和函数，成员变量小写下划线，字段注释保持行尾注释并且保持对齐**
|