学习资料(UE官方文档):https://docs.unrealengine.com/zh-CN/ProductionPipelines/DevelopmentSetup/CodingStandard/index.html
为什么要学?基于UE4引擎开发有一段时间。最近在review写过的代码,让代码规范,更贴近UE的推荐规范(引擎规范),也更容易后期维护
版权声明
- 源码必须加上版权声明,不然不能编。 但如果能脱离ue4引擎编译,应该还有机会(狗头
命名规则
- 每个单词的首字母大写,不用下划线
- 变量、函数(对返回值的描述)和类的名称,一定要清楚明了
- 所有返回布尔的函数,是一个肯定句,而不是模棱两可。应发起true/false的询问,如IsVisible()或ShouldClearBuffer()
- 一个函数如果有形参为&传递,并且要写入返回调用处的,应当加上Out前缀
- 若参数为bool,命名为bOutResult
Others
- const
- 对于不修改的函数,加上const
- 对于不修改的形参,加上const
- 对于不修改的循环,加上const
- 尽可能使用Nullptr代表空指针,而不是NULL
- 尽可能不写auto,这不容易理解
- 对于多bool的函数,在调用的时候很难理解意思,因此改成枚举最好,利用1,2,4,8,16
- 避免过长的参数列表,如果有很多,建议写成结构体
总结:对于代码,检查分三大块:变量(命名),函数(命名,const),类(命名)。以及适当的注释