编码规范

一、类名命名规范及使用约定

类名命名规范

根据各种类的类型和用途，采用不同前缀+名词的命名方式。名词采用波浪法，必须使用可以明确表达变量意义的英文名词。

前缀

UE封装类

?模板类以T 为前缀。

?继承UObject 的类以U 为前缀。

?继承AAtor 的类以A 为前缀。

?继承SWidget 的类以S 为前缀。

?抽象接口类以I 为前缀。

?枚举类由E 为前缀

?布尔变量必须以b 为前缀（比如“bPendingDestruction”，或

“bHasFadedIn”）

?大部分其他类都以F 为前缀, 但某些子系统使用其他字母。

?Typedef 应该由相应的类型来前缀：F 则说明是struct 的typedef，U 则是UObject 的typedef，以此类推

o对于一个模板的特定化实例来做的typedef 则不再是模板，应该用相应的前缀来定义。比如：

typedef TArray FArrayOfMyTypes;

普通类(C++)

一般类，采用C+名词的方式命名

例如：

Class CPerson

{

Protected :

String m_strName;

String m_strNickName;

};

接口类(I)

对于无任何实现的纯虚类，称为接口类，这些类的特点都是无任何成员变量，存在需要其他实现类实现的纯虚函数。

接口类必须采用I+名词的方式命名。

例如：

class IDataInput

{

Public :

virtual ~IDataInput() {};

virtual void read() = 0;

}

结构体(T)

Struct，结构体，必须以T+名词的方式命名。

例如：

typedef struct _t_mystruct

{

Unsigned int number;

Unsigned int value;

Char name[255];

}TMyStruct,* TMyStructPtr;

模板类

模板类，必须以全小写命名。

例如：

template

class screen : public map

{

}

类成员的初始化（Member initialization lists）

成员的初始化必须在构造函数名的下一行开始

正确写法：

gribble::gribble()

:m_private_data(0), m_more_stuff(0), m_helper(0)

{

}

错误写法：

gribble::gribble():m_private_data(0),m_more_stuff(0), m_helper(0)

{

}

二、数据变量命名规范

常量的命名规范：

常量名由全大写字母组成，单词间通过下划线来界定。如：const Int32 MAX_AMMO = 100; 成员变量的命名规范：

m+_+[变量类型]+变量名

m后带上明确表达变量意义的英文名词而不要用难以表达意义的缩写。且m后的变量名首字母必须大写。如：

class CMyGame

{

private :

CPoint m_Point;<―――普通类型

CGame* m_pGame;<―――指针类型

Int32 m_nGameID;<―――整数类型

}

函数参数的命名规范：

采用波浪法来定义函数参数变量。同样的，也必须使用可以明确表达变量意义的英文名词，而不仅仅是缩写。

[变量类型]+变量名

如定义一个读取文件的函数，并且用参数传入一个文件名

public boolean readFile(String str FileName)

{

…

m_sFileName = str FileName;

}

局部变量的命名规范：

采用全部小写的方式定义局部变量名。而且尽量用有意义的名词作为变量名。

局部变量不需要在前面增加变量类型标识。

public boolean readFile()

{

String filename = “e.ext”;

}

局部循环变量的命名规范：

用小写的i、j、k依次作为循环变量

如：

for (int i = 0 ; i < 10 ; i ++ )

{

for (int j = 0 ; j <10 ; j ++ )

{

}

}

使用Auto

如：

TMap m_mapTest;

for (auto& Kvp : m_mapTest)

{

UE_LOG(LogCategory, Log, TEXT("Key: %s, Value: %d"), Kvp.Key, *Kvp.Value);

}

临时变量的命名规范：

一般情况下尽量使用有意义的变量名，如果是某变量的临时变量，可采用前面增加tmp 前缀的方式。如果实在没办法，可采用tmp、temp等作为临时变量名，但不可以过多定义诸如tmp1、tmp2等变量，如果出现此情况，则必定可以采用有意义的名词代替。

int tmpserialno = m_nSerialNo++;

tmpserialno %= 10;

m_nSerialNo = tmpserialno;

枚举常量

采用波浪法加E前缀来定义枚举常量。同样的，也必须使用可以明确表达变量意义的英文名词，而不仅仅是缩写。且E后首字母必须大写

例如：

UENUM()

enum class EThing : uint8

{

Thing1,

Thing2

};

基本C++数据类型的可移植别名

?bool 代表布尔值(永远不要假设布尔值的大小) 。BOOL 将不会进行编译。?TCHAR 代表字符型（永远不要假设TCHAR的大小）。

?uint8 代表无符号字节（占1个字节）。

?int8 代表有符号的字节（占1个字节）。

?uint16 代表无符号"短整型" (占2 个字节)。

?int16 代表有符号"短整型" (占2 个字节)。

?uint32 代表无符号整型（占4字节）。

?int32 代表带符号整型（占4字节）。

?uint64 代表无符号"四字" (8个字节)。

?int64 代表有符号"四字"（8个字节）。

?float 代表单精度浮点型(占4 个字节)。

?double 代表双精度浮点型(占8 个字节)。

?PTRINT 代表可以存放一个指针的整型(永远不要假设PTRINT的大小)。请不要在可移植代码中使用C++ 整型，因为需要根据编译器决定这种数据类型的大小。

变量类型：

基本类型(保留类型)

指针类型:

在变量类前增加p标识，作为标识此变量为指针类型，如：

int *pKey = NULL;

CDateTime* pDateTime = new CDateTime(0);

数组变量命名规范：

对于数组类型的变量，需要采用复数s以标识此为数组变量。如：

int m_nKey s[100];

double dValues[200];

CMyClass Strings[200];

对于数组指针变量，同样在类型前增加p标识。在删除的时候，必须用delete[]的方式删除动态数组，以保证数组内的实例被调用析构函数。

CDateTime* pBirthdays = new CDateTime[20];

....

delete[] pBirthdays;

int* m_pnKeys = new int[20];

三、函数命名规范

函数名称原则上采用动词名词的组合形式，函数名称采用波浪法，私有函数（private）第一个单词首字母采用小写，后面的单词的首字母采用大写，受保护函数和公开函数（protected和public）第一个单词首字母采用大写

如：

private:

int getTopicID();

protected:

void OnClick();

public:

ACharacter* GetPlayer();

成员变量必须采用private的定义，不允许使用public定义，并置于类定义的最后，另外用getter和setter的函数访问和修改之（在需要考虑程序大小或者需要将成员变量暴露给蓝图的时候可以忽略此规则）

class CTest

{

public :

int getTopicID()

{

return m_nTopicID;

}

void getTopicID(int nTopicID)

{

m_nTopicID = nTopicID;

}

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "玩家属性")

FName m_naPlayerName;

private：

TInt m_nTopicID;

}

一个函数只完成一个任务，不要把多个任务放在一个函数中，即使那些任务非常小

服务端消息或客户端消息都应该以handle开头

handleLogin

handleLogout

handleMainViewClose

handleGoldChange

事件的响应函数和派发函数都应该以On开头

OnDeath

OnPickup

OnReceiveMessage

OnMessageRecieved

OnTargetChanged

OnClick

OnLeave

每个函数的大小不要超过100行

四、Const 正确性

const 既是对编译器工作的引导，也是说明文档，因此应该尽可能的遵守正确使用const 的形式。

这里包括当函数不修改传入参数时，应在参数中使用const 指针或引用，如果一个函数不修改对象则将它标记为const，以及在对于不修改外部容器的循环使用const 修饰。

void SomeMutatingOperation(FThing& OutResult, const TArray& InArray); // InArray不可以被函数内部修改, 但OutResult的属性可以被修改

void FThing::SomeNonMutatingOperation() const

{

//此代码不会修改它所在的类（this）的成员变量

}

TArray StringArray;

for (const FString& : StringArray)

{

// 该循环不可以修改StringArray的内容

}

Const 也应该对于使用值的方法下被使用。这里就告诉代码的读者该变量并不会在函数体内修改，会帮助理解代码。这么做的事情也请保证函数申明和定义一致，因为这也会影响JavaDoc 的过程：

void AddSomeThings(const int32 Count);

void AddSomeThings(const int32 Count)

{

const int32 CountPlusOne = Count + 1;

// 函数内部不可以对Count或者CountPlusOne进行修改

}

这里有个值传递参数的例外（查看"Move semantics"），但这种情况很少见。

void FBlah::SetMemberArray(TArray InNewArray)

{

MemberArray = MoveTemp(InNewArray);

}

将const 关键字放到后面来表示一个指针本身是常量（而不是它指向的内容）。这里表示该指针无法被“重新指向”。

// 指向T类型的常量指针，它不能再指向别的变量，但指向（变量）的值可以修改

T* const Ptr = ...;

不要用const 来修饰返回值类型，这是一个move semantics 的用法，为了复杂类型并会对内建类型产生编译警告。这条规则仅对数组类型本身起效，并不对返回的指针类型或引用类型的目标起效。

// 不建议 - 返回一个常量数组

const TArray GetSomeArray();

// 推荐 - 返回一个常量数组的引用

const TArray& GetSomeArray();

// 推荐 - 返回一个常量数组的指针

const TArray* GetSomeArray();

// 不建议 - 返回一个常量数组的常量指针

const TArray* const GetSomeArray();

五、其他良好的编程习惯

缩进采用tab而不是用space；tab的缩进显示距离建议为4个空格

用一个空行来分开代码和逻辑的分组；

大括号{ }

if-else 语句的每个代码执行块都应该位于大括号内。这是为了防止编辑错误- 如果没有使用大括号，某人可能会不经意地向if 代码块中添加另一行代码。而这行代码并不会受到if表达式的控制，这是非常糟糕的。更糟糕的是，当条件化地编译各项时会导致if/else 语句中断。所以一定要使用大括号。

if(HaveUnrealLicense)

{

InsertYourGameHere();

}

else

{

CallMarkRein();

}

多重if 语句在缩进时应该让每个else if 语句的缩进和首个if 语句对齐，这样对读者来说结构更加清晰。

if(TannicAcid < 10)

{

Log("Low Acid");

}

else if(TannicAcid < 100)

{

Log("Medium Acid");

}

else

{

Log("High Acid");

}

在每个运算符和括号的前后都空一格。

无warning编译

六、代码注释规范

UE4使用基于JavaDoc 的系统来自动地从代码中提取注释并构建成文档，所以这就要求遵循一些特定的注释格式规则。

以下示例展示了类、状态、方法和变量的注释格式。请记住注释应该是辅助加强代码的。代码是功能实现，注释表明了代码的目的。请确保在您更改一段代码意图时更新注释。

注意，正如下面Steep和Sweeten方法所呈现的，我们支持两种不同的参数注释风格。Steep所应用的@param风格是传统风格，但对于简单的函数来说，把参数介绍集成到函数的描述性注释中会使其看上去更加清晰，正如Sweeten 中的注释所示。

和UE3编码规范不同，UE4中应该仅包含一次方法注释，即在公开声明方法的地方提供该注释。方法注释应该仅包含和方法的函数调用相关的信息，包括可能和该函数调用相关的方法重载的任何信息。关于那些和函数调用无关的方法及其重载方法的实现细节，应该在方法实现内部进行注释。

/** 可饮用对象的接口。*/

class IDrinkable

{

public:

/**

* 当玩家饮用该对象时调用。

* @param OutFocusMultiplier - 返回时，将包含乘数以应用于饮用者。

* @param OutThirstQuenchingFraction - 返回时，将包含饮用者的口渴值的分数值归0 (0-1)。

*/

virtual void Drink(float&OutFocusMultiplier,float&OutThirstQuenchingFraction)= 0;

};

/** 一杯茶(茶) */

class FTea :public IDrinkable

{

public:

/**

* 根据浸泡茶的水的体积和水温来计算茶叶的变换口味值。

* @param V olumeOfWater - 以毫升计算的用于酿造的水量

* @param TemperatureOfWater - 以开氏度计算的水温

* @param OutNewPotency - 在浸泡开始后的茶叶效能，从0.97到1.04

* @return 会返回每分钟茶叶口味单位值(TTU) 中茶叶浓度的改变

*/

float Steep(

float V olumeOfWater,

float TemperatureOfWater,

float&OutNewPotency

);

/** 对茶叶添加甜味剂，根据产生相同甜度的蔗糖的量来作为数量，以克计算。*/

void Sweeten(float EquivalentGramsOfSucrose);

/**在日本出售的茶叶的价格，以日元为单位。*/

float GetPrice()const

{

return Price;

}

// IDrinkable接口

virtual void Drink(float&OutFocusMultiplier,float&OutThirstQuenchingFraction);

private:

/** 以日元计算的茶叶的价值。*/

float Price;

/** 茶叶的甜味，根据产生相同甜度的蔗糖的量来作为数量，以克计算。*/

float Sweetness;

};

代码在修改过后也要及时更新注释，确保下个阅读该段代码的人不会产生误会。

多写一行注释可能多花你几分钟的时间，但别人看的时候可能就是节省几个小时，所以现在强制要求头部

文件全部函数和变量都要写注释，即使这段代码的意思显而易见，请各位成员养成良好的习惯！

函数体内注释规范

一般在函数内如果需要注释的话，可采用//的方式进行注释说明，如果多行的注释也建议采用//的方式

七、蓝图规范

请时刻遵循C++代码为主，蓝图为辅的原则，C++能实现的功能就用C++实现，如果碰到C++没有提供直接的函数库，例如动画系统的骨骼变形，可以通过继承C++类，从C++里面传递参数在蓝图里面实现功能。

在UE编辑器显示中文

如图所示，添加了中文注释或者Category设置成中文之后，需要在高级保存选项中设置编码为UTF-8，否则所有中文都会在编辑器里面显示乱码。

.又或者你可以直接安装一个VS插件——ForceUTF8，这样所有保存的文件都会被转成UTF8编码。

拆分子函数

请遵循跟C++一样的原则，不要在同一个图表内把所有函数写满，应该遵循函数任务最小化的原则把图表拆分为多个子函数。并且所有蓝图连接线都应该水平拉直，不要意大利面条式的蓝图布局。

在适当的位置添加注释

再次强调，一定要写注释！

虽然并不推荐在蓝图里面重载C++的函数，但如果有，请在C++注释里面强调这是在蓝图里面实现为主的功能

变量和函数声明

如果需要在蓝图里面实现功能，请把内部变量和函数在C++里面声明，通过继承的方式传递到蓝图里面调用。临时变量可在蓝图里面声明。

本规范参考：

https://https://www.360docs.net/doc/686811630.html,/skylens-inc/ue4-style-guide/blob/master/README.md

https://www.360docs.net/doc/686811630.html,/latest/CHN/Programming/Development/CodingStandard/inde x.html