UE4编码规范

翻译原文为Unreal 的官方！自己看着总结了一下，不一定每条都能对上。不足之处，请多多不吝赐教！

原文地址： unreal CodingStandard

UE4编码规范

在Epic，有简单几条代码编写标准：

l 代码生命的80%时间在于维修

l 没有一个软件在整个过程中仅仅有原作者在维护

l 编码规范能够提供软件可读性，新手可迅速透彻理解代码。新的project师来会建立新的project改动代码。

l 若对社区开发人员放出源代码，希望代码易于理解。

l 须要满足交叉编译。

命名规范

l 首字母大写，不使用下划线

l 第一个字母为变量类型。

模块前缀为T

继承UObject前缀为U

继承AActor前缀为A

继承SWidget前缀为S

继承抽象接口前缀为I

其它大多数前缀为F，也有一些子类用其它字母。

l 类型和变量为名词

l 方法行为名称为动词，描写叙述方法作用，或返回值。

变量和方法，类名须要清晰，避免过度缩写。

全部变量一次仅仅能声明一个，凝视能够正常使用。javaDocs类型须要它们。你能够多行或单行凝视来凝视。

函数须要返回bool型，bool变量的前缀为b.

无返回值函数，须要动词后面加对象。名称避免不明白功能的字眼

基础C++对象类型

bool不要使用BOOL

TCHAR,不用使用CHAR

uint8

int8

uint16

int16

uint32

int32

Uint64

Int64

Float,单精度浮点

Double,双精度浮点数

PTRINT，带有指针的整型

凝视

凝视即沟通，沟通非常关键。将凝视印在脑海。（Kernighan & Pike The Practice of Programming ）

UE4使用JavaDoc来自己主动解析代码凝视，编译生成文档。所以要注意凝视格式。

C++11新特性使用

能够非常好支持的眼下主要有auto,for循环和lambda表达。有时候我们仅仅是用宏定义这样特性折叠了。

l Auto

使用auto,在编译期间绑定变量类型。若鼠标悬停在vs变量上，将会告诉你auto变量的实际类型。

l For循环

代码更简洁，易于维护。

l Lambda表达匿名函数

Lambda是可用的，可是眼下我们使用非常慎重。

第三方代码

编码格式

{}须要另起一行。

If-else，不论什么使用都要使用括号。多行可用把else-if放在一行上。

Switch，必有一个default.

命名空间

l 使用自己的命名空间，注意不要重名，尤其不要与第三方库重名

l 不使用using在全局范围，甚至在cpp中也不使用。

l 在命名空间里使用命名空间，或在函数内使用命名空间是没问题。

l 使用命名空间要确认一致性。

l 前向声明类型须要在他们单独的命名空间中进行。

l 若声明了大量的类或类型在一个命名空间下，则在全局范围内使用须要明白的支出命名空间

l Using，最好不要使用别名。

l 枚举类型在命名空间里声明，防止全局都可见。

物理独立

全部编译器支持#pragma once.

要直接使用头文件包括，不要间接的使用。

不要操心头文件的的预编译头设置，UnrealBuild比你做的要好。

常见格式

l 变量在近期的使用地方定义。

l 尽可能切割多的方法。

l 函数声明或调用，函数名称之前不要空格。

l 在.h和cpp文件结尾加上一行空格，由于Gcc编译须要。

l 不要把浮点float隐形转换为int，由于不是所以编译器能够编译的。要使用appTrunc()来转换。

l 不是接口的，要用private类型保护数据。

l 接口类不要写变量。接口类里同意非纯虚函数，或非虚函数或静态函数的。

l 多使用const.

l 切割多个表达，使代码易于理解。使用中间变量使复杂表达简单化。

const bool bIsLegalWindow = Blah->BlahP->WindowExists->Etc && Stuff;

	const bool bIsPlayerDead = bPlayerExists && bGameStarted && bPlayerStillHasPawn && IsTuesday();

	if (bIsLegalWindow && !bIsPlayerDead)

	{

		DoSomething();

	}

l 虚函数记得使用override

l 指针的*号，靠近对象来放置，便于搜素某类型的指针类对象。

----------------------

若有问题，请随时联系！