(完整word版)编码规范.doc

类名命名规范及使用约定

类名命名规范

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

前缀

UE封装类

模板类以T为前缀。

继承UObject的类以U为前缀。

继承AAtor的类以A为前缀。

继承SWidget的类以S为前缀。

抽象接口类以I为前缀。

枚举类由E为前缀

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

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

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

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

typedefTArrayFMyTypeFArrayOfMyTypes;

普通类(C++)

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

例如：

ClassCPerson

{

Protected:

Stringm_strName;

Stringm_strNickName;

};

接口类(I)

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

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

例如：

classIDataInput

{

Public:

virtual~IDataInput(){};

virtualvoidread()=0;

}

结构体(T)

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

例如：

typedefstruct_t_mystruct

{

Unsignedintnumber;

Unsignedintvalue;

Charname[255];

}TMyStruct,*TMyStructPtr;

模板类

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

例如：

templateclassT,allocatorA

classscreen:publicmapT,A

{

}

类成员的初始化（Memberinitializationlists）

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

正确写法：

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)

{

}

数据变量命名规范

常量的命名规范：

常量名由全大写字母组成，单词间通过下划线来界定。如：constInt32MAX_AMMO=100;

成员变量的命名规范：

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

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

classCMyGame

{

private:

CPointm_Point;―――普通类型

CGame*m_pGame;―――指针类型

Int32m_nGameID;―――整数类型

}

函数参数的命名规范：

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

[变量类型]+变量名

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

publicbooleanreadFile(StringstrFileName)

{

…

m_sFileName=strFileName;

}

局部变量的命名规范：

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

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

publicbooleanreadFile()

{

Stringfilename=“e.ext”;

}

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

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

如：

for(inti=0;i10;i++)

{

for(intj=0;j10;j++)

{

}

}

使用Auto

如：

TMapFString,int32m_mapTest;

for(autoKvp:m_mapTest)

{

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

}

临时变量的命名规范：

一般情况下尽量使用有意义的变量名，如果是某变量的