CMake
XMake
C++
- Treat warning as error:
WX->WX-
库开发：
- 避免全局状态，否则其生命周期的管理会相当麻烦
- 不要在公共头文件中定义通用类型，否则不同编译器的字节对齐会出现问题
- 不要在公共头文件中包含
windows.h - 小心对待自己的命名空间，不要导出你不想公开的符号
- 尝试建立稳定的 ABI
- 不要对结构体太疯狂
- 允许别人自定内存分配器。如果不能对每个
context这样做，至少在每个库中这样做 - 不要强迫用户使用你所喜欢的构建工具，始终确保用户可找到 VisualStudio 和 Make 的解决方案。
API 设计准则
- 最简原则。公开的 API 应简洁，不冗余。只公开必须公开的。
- 完整。API 能准确无误完成预期功能。
- 最少惊讶原则。
- 直观。无需查阅文档，即可知使用此 API 编写的代码，则为直观。
- 易于记忆。选择一致且精确的命名规则。
- 时刻可读。Code Once, Read Many times。
编码中常用注释标记
| 标记 | 意义 |
|---|---|
| TODO | 表明尚未完成，需要后期完成 |
| TEST | 表明待测试 |
| REVIEW | 代码待审查，需要代码是否完美达成目标 |
| HACK | 表明当前实现的代码不完美，比较蛮力，需要后期再重新编写 |
| FIXME | 表明当前的代码有点问题，需要被修改 |
| OPTIMIZE | 代码性能有问题，需要被优化，提高性能 |
| @,@see,@refer等 | 通常表示引用。如@see Game.js 表示如果有问题，可以参考Game.js文件 |
| \param,\return等 | 用于描述函数的参数和返回值分别是什么，有什么作用。 |