UE4编码规范

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

原文地址:  unreal CodingStandard

UE4编码规范

在Epic,有简单几条代码编写标准:

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

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

l 编码规范可以提供软件可读性,新手可迅速透彻理解代码。新的工程师来会建立新的工程修改代码。

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 指针的*号,靠近对象来放置,便于搜素某类型的指针类对象。

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

若有问题,请随时联系!

时间: 2024-10-12 04:42:28

UE4编码规范的相关文章

java编码规范

右括号") "与其后面的关键字之间,关键字与其后面的左括号"("或"{"之间,以及"}"与"{"之间,要以一个空格隔开:除". "外,所有二元操作符的前.后要加空格:在逗号后边加一个空格. 说明: 一个紧跟着括号的关键词应该被空格分开: 空白应该位于参数列表中逗号的后面: 所有的二元运算符,除了".",应该使用空格将之与操作数分开.一元操作符和操作数之间不应该加空格,

我也学php:编码规范/翻译自PSR

PHP社区百花齐放,拥有大量的函数库.框架和组件.PHP开发者通常会在自己的项目中使用若干个外部库,因而PHP代码遵循或尽量接近同一个代码风格就非常重要,可以让开发者方便地把多个代码库集成在自己的项目中. 框架互操作组(即PHP标准组)发布了一系列代码风格推荐标准,即PSR-0,PSR-1,PSR-2和PSR-3. 不要让这些名称所混淆,这些推荐仅是一些被其它项目所遵循的规则,如Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Li

阿里Java编码规范

详细,全面 很不错 阿里 Java编码规范

html编码规范

不久前接到老大下达的任务,要拟定一份公司前端编码规范的草稿,参考了各大公司的编码规范,结合现在公司的特点,整理出以下编码规范: html规范 1 文件相关 (1) 文件名以英文为主,可以使用下划线(如active.html),压缩包以项目名+日期的形式. (2) 统一使用utf-8编码. (3) css.js发布到线上都需要压缩. (4) 在追求高度优化的站点,需要对图片也进行无损压缩. 2 代码风格 2.1 命名 (1) 元素 id 必须保证页面唯一.(解释:同一个页面中,不同的元素包含相同的

【转】Airbnb React编码规范

Airbnb的编码规范是在业界非常流行的一套规范,而且它一直都在进化,推出最新技术的规范 原文:https://zhuanlan.zhihu.com/p/20616464 用更合理的方式书写React和JSX 基本规则 每个文件只包含一个React组件: 但是无状态, 或者 Pure 组件 允许一个文件包含多个组件.eslint: react/no-multi-comp. 始终使用 JSX 语法; 不要使用 React.createElement方法,除非初始化 app 的文件不是 JSX 格式

Bootstrap编码规范

黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过 open an issue on GitHub为本规范添加或贡献内容. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. HTML 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-clo

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

说说Python编码规范

前言 已有近两个月没有发表过文章了,前段时间外甥和女儿过来这边渡暑假,平常晚上和周末时间都陪着她们了,趁这个周末有空,再抽空再把这块拾起来.         这么久没写了,再次拿起键盘,想想,发表些什么呢,想起上次公司的代码评审委员会下周其中一个议题是关于Python编码规范的整理,那就趁热打铁,整理一份关于Python编码规范的文章,也为那些写Python的人,提供一些编码注意的一些事项或者说是参考吧. 编码规范的作用         规范故明思义,就是通过不断的总结,吸取好的点,从而形成的一

Android 编码规范

编码规范对于程序员而言,尤为重要,有以下几个原因: 一个软件的生命周期中,80%的花费在于维护: 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发来维护: 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码: 如果你将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误,一如你已构建的其他任何产品: 命名 1.包命名 包名规则:一个唯一的包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,如com.edu.gov.net.org等.包名的后续部分根据不同机构各