언리얼 코딩 표준
에픽에서 저희는 단순한 코딩 표준과 규칙이 몇가지 있습니다. 이 문서는 논의중이거나 작업중인 내용이라기 보다는, 현재 에픽에서 시행중인 코딩 표준 상태를 반영한 것입니다.
프로그래머들에게 있어서, 코딩 규칙은 매우 중요합니다. 그 이유 중의 몇 가지 는 다음과 같습니다:
-
하나의 소프트웨어가 그 수명을 지속하는 동안 들어가는 경비 가운데 80%는 유지 보수비입니다.
-
원저자가 그 소프트웨어의 수명이 다할 때까지 관리하는 일은 거의 없습니다.
-
코딩 규칙은 그 소프트웨어를 한층 읽기 쉽도록 해주므로, 엔지니어들은 새 코드를 보다 빨리 그리고 철저하게 이해할 수 있습니다.
-
만일 저희가 mod 커뮤니티 개발자들께 소스 코드를 공개하기로 결정한다면, 이해하기 쉬운 것이기를 바랍니다.
-
사실 이 규칙 가운데 상당수는 컴파일러간의 호환을 위해 필요한 것이기도 합니다.
아래 코딩 표준은 C++ 에 특화되어 있지만, 표준이라는 개념은 어떤 언어를 사용하든 상관없이 따르도록 하고 있습니다. 가급적 한 섹션에는 특정 언어에 대해 상응하는 규칙이나 예외가 제공될 수 있습니다.
클래스 체계
클래스 체계는 작성하는 사람 보다는 읽는 사람을 염두에 두고 체계를 잡아야 합니다. 읽는 사람 대부분은 클래스의 공용 인터페이스를 쓸 것이기에, public 을 먼저 선언하고, 그 후 클래스의 private 구현이 뒤따릅니다.
저작권 공지
에픽이 배포용으로 제공한 (.h, .cpp, .xaml, 등의) 소스 파일은 반드시 파일의 첫 줄에 저작권 공지를 포함시켜야 합니다. 공지의 포맷은 반드시 다음과 같아야 합니다:
// Copyright 1998-2018 Epic Games, Inc. All Rights Reserved.
이 줄이 없거나 포맷이 다르게 되어 있다면, CIS 가 오류를 내고 중단시킬 것입니다.
작명 규칙
-
(유형이나 변수 등의) 이름 내 각 단어의 첫 글자는 대문자로 써야 하며, 단어 사이에 보통은 공백을 띄우지 않습니다. Health 와 UPrimitiveComponent 정도를 예로 들 수는 있지만, lastMouseCoordinates 나 delta_coordinates 같은 것은 아닙니다.
-
변수 이름과 구분하기 위해 유형 이름을 대문자 한 글자로 나타내는 접두사를 붙입니다. 예를 들어 FSkin 이 유형 이름이고, Skin 은 FSkin 의 인스턴스 입니다.
-
템플릿 클래스 접두사는 T 입니다.
-
UObject 에서 상속하는 클래스 접두사는 U 입니다.
-
AActor 에서 상속하는 클래스 접두사는 A 입니다.
-
SWidget 에서 상속하는 클래스 접두사는 S 입니다.
-
추상 인터페이스인 클래스 접두사는 I 입니다.
-
Enum (열거형)의 접두사는 E 입니다.
-
Boolean (부울) 변수의 접두사는 b 입니다 (예: bPendingDestruction 또는 bHasFadedIn).
-
그 외 대부분 클래스의 접두사는 F 이나, 일부 서브시스템은 다른 글자를 사용하기도 합니다.
-
Typedef 접두사는 적합한 유형을 붙여야 합니다: 구조체의 typedef 인 경우 F, UObject 등의 typedef 인 경우 U 입니다.
-
C# 에서는 접두사가 생략됩니다.
-
UnrealHeaderTool (언리얼 헤더 툴)은 대부분의 경우 올바른 접두사가 필수이므로, 제대로 붙여주는 것이 중요합니다.
-
유형과 변수명은 명사입니다.
-
메서드 이름은 동사로 그 메서드가 하는 일이나, 하는 일이 딱히 없는 경우 반환값을 설명합니다.
변수, 메서드, 클래스 이름은 명확하고 애매하지 않으며 서술적이여야 합니다. 이름의 범위가 클 수록, 서술적인 좋은 이름의 중요성 역시 커집니다. 과도한 축약은 피하시기 바랍니다.
모든 변수는 변수에 대한 설명을 코멘트로 붙일 수 있도록 한 번에 하나씩만 선언해야 합니다. 이난 JavaDocs 스타일에서도 요구하는 바입니다. 변수 앞에 여러 줄짜리든 한 줄짜리든 코멘트를 남기면 되며, 변수 그룹 목적으로 빈 줄을 띄워도 됩니다.
모든 부울은 True / False 값을 묻습니다. 부울을 반환하는 함수도 모두 마찬가지입니다.
프로시져(반환값이 없는 함수)는 강한 동사 뒤에 오브젝트를 붙여 써야 합니다. 예외는 메서드의 오브젝트가 그 안에 있는 오브젝트일 때인데, 그런 경우 오브젝트는 컨텍스트에서 이해를 합니다. "Handle" 이나 "Process" 같은 것으로 시작하는 이름은 애매하니 피해 주시기 바랍니다.
필수는 아니지만, 함수 파라미터 중 레퍼런스로 전달된 이후 함수가 그 값에 출력할 것으로 기대되는 것의 경우 이름 앞에 "Out" 접두사를 붙일 것을 추천합니다. 그래야 이 인수로 전달되는 값은 함수가 대체시킬 것임이 명확해 집니다.
In 또는 Out 파라미터 역시 부울인 경우, In/Out 접두사 앞에 b 를 붙입니다, 예: bOutResult.
값을 반환하는 함수는 반환값에 대한 설명을 해야 합니다. 이름을 통해 함수가 반환하게 될 값을 명확히 알 수 있어야 하지요. 이는 부울 함수의 경우 특히나 중요합니다. 다음 두 예제 메서드를 살펴 봅시다:
bool CheckTea(FTea Tea) {...} // true 면 뭐라는 걸까요? bool IsTeaFresh(FTea Tea) {...} // true 면 차가 신선하다는 것이 명확해집니다.
예제
float TeaWeight; int32 TeaCount; bool bDoesTeaStink; FName TeaName; FString TeaFriendlyName; UClass* TeaClass; USoundCue* TeaSound; UTexture* TeaTexture;
기본 C++ 유형에 이식가능 앨리어스
-
bool - boolean (bool 크기 추정 금지). BOOL 은 컴파일되지 않습니다.
-
TCHAR - character (TCHAR 크기 추정 금지)
-
uint8 - unsigned byte (1 바이트)
-
int8 - signed byte (1 바이트)
-
uint16 - unsigned "short" (2 바이트)
-
int16 - signed "short" (2 바이트)
-
uint32 - unsigned int (4 바이트)
-
int32 - signed int (4 바이트)
-
uint64 - unsigned "quad word" (8 바이트)
-
int64 - signed "quad word" (8 바이트)
-
float - single precision floating point (4 바이트)
-
double - double precision floating point (8 바이트)
-
PTRINT - 포인터를 가질 수 있는 integer (PTRINT 크기 추정 금지)
C++ 의 int 와 unsigned int 유형은 플랫폼에 따라 크기가 변할 수 있기에 정수 범위가 중요치 않은 경우라면 코드에서 사용해도 괜찮습니다. 명시적으로 크기가 정해진 유형은 여전히 시리얼라이즈 또는 리플리케이트된 포맷으로 사용해야 합니다.
코멘트
코멘트는 소통이고, 소통은 중요합니다. 코멘트에 대해 명심하실 점이 몇 가지 있습니다 (Kernighan & Pike 의 The Practice of Programming 에서):
지침
-
자체적으로 설명이 되는 코드를 작성하세요:
// 나빠요: t = s + l - b; // 좋아요: TotalLeaves = SmallLeaves + LargeLeaves - SmallAndLargeLeaves;
-
도움이 되는 코멘트를 작성하세요.
// 나빠요: // Leaves 증가 ++Leaves; // 좋아요: // 찻잎이 더 있다는 것을 알았습니다. ++Leaves;
-
코드를 모순되게 만들지 마세요:
// 나빠요: // Leaves 절대 증가 아님! ++Leaves; // 좋아요: // 다른 잎이 있다는 것을 압니다. ++Leaves;
Const 정확도
const 는 문서이자 컴파일러 지시자이기도 하므로, 모든 코드는 const 정확도를 맞추도록 해야 합니다.
여기에 포함되는 경우는, 함수 인수가 함수에 변경되지 않아 함수 인수를 const 포인터 또는 참조 전달하는 경우, 메서드가 오브젝트를 변경하지 않아 const 플래그를 붙이는 경우, 루프에서 컨테이너 자체에 대한 변경을 하지 않아 const 를 사용하여 컨테이너에 반복처리를 하는 경우가 포함됩니다.
void SomeMutatingOperation(FThing& OutResult, const TArray<int32>& InArray); // InArray 는 SomeMutatingOperation 에 의해 변경되지 않지만, OutResult 는 변경될 수도 있습니다. void FThing::SomeNonMutatingOperation() const { // 이 코드는 자신을 부른 FThing 을 변경하지 않습니다. } TArray<FString> 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 도 함수 바디에서 변경 불가능합니다. }
여기에 한 가지 예라면 값 전달 파라미터는 궁극적으로 컨테이너 속에 이동될텐데 ("이동 시맨틱" 참고), 드문 경우일 것입니다.
void FBlah::SetMemberArray(TArray<FString> InNewArray) { MemberArray = MoveTemp(InNewArray); }
포인터(가 가리키는 것이 아닌) 자체를 const 로 만들 때는 끝에 cont 키워드를 넣으십시오. 레퍼런스는 어떻게든 '재할당' 불가능하며, 같은 방식으로 const 로 만들 수 없습니다:
// const 이외 오브젝트로의 const 포인터 - 포인터는 재할당 불가능하나, T 는 여전히 변경 가능합니다. T* const Ptr = ...; // 틀림 T& const Ref = ...;
반환형에는 const 를 사용하지 마십시오. 복잡한 유형에 대한 이동 시맨틱이 제한되며 내장된 유형에는 컴파일 경고가 나기 때문입니다. 이 규칙은 반환형 자체에만 적용되며, 반환되는 포인터 또는 레퍼런스 타깃 유형은 아닙니다.
// 나쁨 - const 배열 반환 const TArray<FString> GetSomeArray(); // 좋음 - const 배열로의 레퍼런스 반환 const TArray<FString>& GetSomeArray(); // 좋음 - const 배열로의 포인터 반환 const TArray<FString>* GetSomeArray(); // 나쁨 - const 배열로의 const 포인터 반환 const TArray<FString>* const GetSomeArray();
예제 포맷
저희는 JavaDoc 기반 시스템을 사용하여 코드에서 코멘트를 자동으로 추출한 뒤 문서를 만들기 때문에, 코멘트에는 따라야 하는 특수한 포맷 규칙이 몇 가지 있습니다.
다음 예제는 클래스, 스테이트, 메서드, 변수 코멘트의 포맷을 선보입니다. 기억하실 것은, 코멘트는 코드를 증강시켜야 합니다. 코드는 구현을 설명하고, 코멘트는 그 의도를 설명합니다. 코드 한 줄의 의도를 바꾸더라도 반드시 코멘트를 업데이트하시기 바랍니다.
참고로 지원되는 파라미터 코멘트 스타일은 두 가지로, Steep 와 Sweeten 메서드로 구체화되어 있습니다. Steep 이 사용하는 @param 스타일은 전형적인 스타일이지만, 단순 함수의 경우 파라미터 문서를 함수에 대한 설명 코멘트로 통합시키는 것이, Sweeten 예제에서 보듯이 더욱 깔끔할 수 있습니다.
메서드 코멘트는 딱 한번, 메서드가 공개적으로 선언되는 곳에 include 시켜야 합니다. 메서드 코멘트는 다른 호출자에게 관련이 있을 메서드 오버라이드 관련 정보를 포함해서, 메서드 호출자에 관련된 정보만을 담아야 합니다. 메서드 구현에 대한 세부사항이나 호출자에 관련이 없는 오버라이드는 메서드 구현 안에 코멘트를 달아야 할 것입니다.
class IDrinkable { public: /** * 플레이어가 이 오브젝트를 마실 때 호출. * @param OutFocusMultiplier - 반환되면 마신 사람의 포커스에 적용할 배수가 들어갑니다. * @param OutThirstQuenchingFraction - 반환되면 마신 사람의 갈증 해소 정도가 들어갑니다 (0-1). */ virtual void Drink(float& OutFocusMultiplier, float& OutThirstQuenchingFraction) = 0; }; class FTea : public IDrinkable { public: /** * 우려내는 데 사용한 물의 용량과 온도가 주어진 경우 차에 대한 델타-테이스트 값을 계산합니다. * @param VolumeOfWater - 우려내는 데 사용할 물의 양 mL 입니다. * @param TemperatureOfWater - 물의 온도 켈빈입니다. * @param OutNewPotency - 담그기 시작한 이후의 차의 효능으로, 0.97 에서 1.04 까지입니다. * @return 차 강도의 변화를 분당 차 맛 단위(TTU) 로 반환합니다. */ float Steep( const float VolumeOfWater, const float TemperatureOfWater, float& OutNewPotency ); void Sweeten(const float EquivalentGramsOfSucrose); float GetPrice() const { return Price; } virtual void Drink(float& OutFocusMultiplier, float& OutThirstQuenchingFraction) override; private: float Price; float Sweetness; }; float FTea::Steep(const float VolumeOfWater, const float TemperatureOfWater, float& OutNewPotency) { ... } void FTea::Sweeten(const float EquivalentGramsOfSucrose) { ... } void FTea::Drink(float& OutFocusMultiplier, float& OutThirstQuenchingFraction) { ... }
클래스 코멘트에 포함되는 것은?
그런 메서드 코멘트 부분이 뜻하는 바는?
-
함수의 목표가 첫 번째입니다. 여기서는 이 함수가 해결하는 문제 를 설명합니다. 위에서 말씀드린 것처럼, 코멘트는 의도 를 설명하며, 코드는 구현을 설명합니다.
-
그런 다음 파라미터 코멘트가 옵니다. 각 파라미터 코멘트에는 측량 단위, 예상되는 값 범위, "불가능한" 값, 상태/오류 코드의 의미가 포함되어야 합니다.
-
그런 다음 반환 코멘트가 옵니다. 출력 변수 설명과 마찬가지로 예상되는 반환값을 설명합니다.
C++11 및 최신 언어 문법
언리얼 엔진은 다수의 C++ 컴파일러로 대규모 이식이 가능하도록 만들어 졌기에, 기능을 사용할 때는 지원하게 될 수도 있다고 생각되는 컴파일러와의 호환성을 신중히 따져 봅니다. 가끔은 매우 유용한 기능이라 매크로에 저장하여 많이 사용하는 경우도 있지만, 보통은 지원하게 될 거라 생각하는 모든 컴파일러가 최신의 표준을 지원할 때까지는 기다립니다.
범위 기반 for, 이동 시맨틱, 람다처럼 최신 컴파일러에서 잘 지원되는 것으로 보이는 C++ 11 언어 기능을 활용하고 있습니다. 어떤 경우에는 (컨테이너의 rvalue 레퍼런스같은) 전처리기 조건문에서 이러한 기능을 묶어 사용할 수 있도록 하고 있습니다. 그러나 새 플랫폼에서 문법을 소화시키지 못하여 혼란이 야기될 수 있는 기능에 대해서는, 확신이 들기 전까지 채택하지 않을 수 있습니다.
아래에 지원되는 최신 C++ 컴파일러 기능이라 명시한 것 이외의 컴파일러 전용 언어 기능에 대해서는, 전처리기 매크로나 조건문에 묶어두지 않고서야 사용을 삼가야 하며, 그랬다 해도 조심히 사용해야 합니다.
static_assert
이 키워드는 컴파일 시간 어서트가 필요한 경우에 사용할 수 있습니다.
override 와 final
이 키워드들은 사용할 수 있을 뿐 아니라, 강력히 권합니다. 이들이 빠진 곳이 많이 있을 수 있으나, 서서히 고쳐갈 것입니다.
nullptr
모든 경우 C 스타일 NULL 매크로 대신 nullptr 을 사용해야 합니다.
이에 대한 한 가지 예외라면, C++/CX 빌드(예: Xbox One)의 nullptr 은 사실 매니지드 널 레퍼런스 유형입니다. 유형이나 어떤 템플릿 인스턴스화 컨텍스트를 제외하고는 네이티브 C++ 의 nullptr 과 거의 호환되므로, 호환성을 위해서는 좀 더 일반적인 decltype(nullptr) 대신 TYPE_OF_NULLPTR 매크로를 사용해야 합니다.
'auto' 키워드
아래 몇 가지 예외를 제외하고 C++ 에서 auto 를 사용해서는 안됩니다. 항상 초기화시키려는 유형은 명시해 줘야 합니다. 그 유형이 독자에게 명확히 보여야 한다는 뜻입니다. 이 규칙은 C# 의 var 키워드 사용에도 적용됩니다.
auto 를 사용해도 괜찮은 경우는?
-
변수에 람다를 바인딩해야 하는 경우, 람다 유형은 코드에 표현 가능하지 않습니다.
-
이터레이터 변수의 경우, 유형이 매우 장황하여 가독성에 악영향을 끼칠 수 있습니다.
-
템플릿 코드에서, 표현식의 유형을 쉽게 식별할 수 없는 경우입니다. 이는 고급에 해당하는 경우입니다.
코드를 읽는 사람이 유형을 명확하게 알 수 있어야 한다는 것은 매우 중요합니다. 일부 IDE 에서 유형을 추론할 수는 있지만, 이는 코드가 안정적인 상태라는 가정하에서입니다. GitHub 같은 곳에서 개별 소스 파일을 독립적으로 확인하거나, merge/diff 툴을 사용하는 사람에게도 도움이 되지 않습니다.
auto 를 사용해도 괜찮다고 확실히 알고 있는 경우, 항상 해당 유형에 const, &, * 를 정확히 사용해야 한다는 점 기억해 주시기 바랍니다. 그렇게 해야 auto 를 통해 추론 유형을 원하는 유형으로 이끌어낼 수 있을 것입니다.
범위 기반 For
(Range Based For) 코드의 가독성과 유지보수성 향상에 도움이 되므로 사용을 추천합니다. 이전 TMap 이터레이터를 사용하는 코드를 이주할 때는, 이전 이터레이터 유형 메서드였던 Key() 와 Value() 함수가 이제 단순히 내재된 키-값 TPair 의 Key 와 Value 칸이 되었음에 유의하세요:
TMap<FString, int32> MyMap; // Old style for (auto It = MyMap.CreateIterator(); It; ++It) { UE_LOG(LogCategory, Log, TEXT("Key: %s, Value: %d"), It.Key(), *It.Value()); } // New style for (TPair<FString, int32>& Kvp : MyMap) { UE_LOG(LogCategory, Log, TEXT("Key: %s, Value: %d"), Kvp.Key, *Kvp.Value); }
몇몇 독립형 이터레이터 유형에 대해 범위로 대체한 것도 있습니다:
// Old style for (TFieldIterator<UProperty> PropertyIt(InStruct, EFieldIteratorFlags::IncludeSuper); PropertyIt; ++PropertyIt) { UProperty* Property = *PropertyIt; UE_LOG(LogCategory, Log, TEXT("Property name: %s"), *Property->GetName()); } // New style for (UProperty* Property : TFieldRange<UProperty>(InStruct, EFieldIteratorFlags::IncludeSuper)) { UE_LOG(LogCategory, Log, TEXT("Property name: %s"), *Property->GetName()); }
람다 및 무명 함수
이제 람다(Lamda)는 모든 컴파일러에 사용할 수 있지만, 그 용법은 주의를 기울여야 합니다. 최적의 사용법은 길이상 두 구문 정도, 특히나 규모가 더 큰 표현식이나 구문의 일부로 사용될 때, 예를 들면 범용 알고리즘의 술부(predicates)에 사용될 때는 더욱 그러해야 합니다.
// 이름에 "Hello" 단어가 포함된 첫 번째 Thing 을 검색합니다. Thing* HelloThing = ArrayOfThings.FindByPredicate([](const Thing& Th){ return Th.GetName().Contains(TEXT("Hello")); }); // 배열을 이름 역순 정렬합니다. AnotherArray.Sort([](const Thing& Lhs, const Thing& Rhs){ return Lhs.GetName() > Rhs.GetName(); });
주의할 점이라면, 스테이트풀 람다는 많이 사용하는 경향이 있는 함수 포인터에 적용할 수 없습니다.
사소한 람다가 아니거나 익명 함수의 문서화는 일반 함수를 문서화할 때와 같은 방식으로 간주해서 해야 합니다. 코멘트를 붙일 때는 몇 줄에 걸쳐서 나눠 붙여줘도 되니 걱정하지 마십시오.
자동 캡처보다 수동 캡처가 선호됩니다 ([&] 와 [=]). 특히 커다란 람다와 유예식 실행이 그렇습니다. 실수로라도 잘못된 캡처 시맨틱으로 변수를 캡처하면 안좋은 결과가 날 수 있으며, 코드 유지보수 과정에서 생길 수 있는 일이니 주의해야 합니다:
-
포인터 참조 캡처와 값 캡처가 때때로 허상 참조를 유발할 수 있는데, 람다가 캡처된 변수의 컨텍스트 외부에서 실행된 경우 그렇습니다:
void Func() { int32 Value = GetSomeValue(); // 다량의 코드 AsyncTask([&]() { // 여기서는 값이 유효하지 않습니다. for (int Index = 0; Index != Value; ++Index) { // ... } }); }
-
값 캡처는 불필요한 복사 작업때문에 퍼포먼스 우려가 있을 수 있습니다:
void Func() { int32 ValueToFind = GetValueToFind(); // ArrayOfThings 가 ValueToFind 만 캡처해야 함에도 [=] 로 잘못 캡처되어 람다가 ArrayOfThings 사본을 취합니다. FThing* Found = ArrayOfThings.FindByPredicate( [=](const FThing& Thing) { return Thing.Value == ValueToFind && Thing.Index < ArrayOfThings.Num(); } ); }
-
잘못 캡처된 UObject 포인터는 가비지 콜렉터에 보이지 않습니다:
void Func(AActor* MyActor) { // MyActor 포인터 캡처가 그 오브젝트의 콜렉팅을 막지 않습니다. AsyncTask([=]() { MyActor->DoSlowThing(); }); }
-
자동 캡처는 멤버 변수가 레퍼런싱된 경우, [=] 가 있다 하더라도 묵시적으로 항상 this 를 캡처합니다. [=] 는 람다에 멤버 변수가 없어도 별도의 사본이 있다는 인상을 줍니다:
void FStruct::Func() { int32 Local = 5; Member = 5; auto Lambda = [=]() { UE_LOG(LogTest, Log, TEXT("Local: %d, Member: %d"), Local, Member); }; Local = 100; Member = 100; Lambda(); // Logs "Local: 5, Member: 100" }
커다란 람다이거나 다른 함수 호출의 결과를 반환할 때는 명시적 반환형을 선호합니다. auto 키워드와 같은 방식으로 고려해야 합니다:
// 여기에 반환형이 없으면 불분명해집니다. auto Lambda = []() -> FMyType { return SomeFunc(); };
자동 캡처와 묵시적 반환형은 Sort 호출처럼 시맨틱이 명확해서 명시해 줘도 과잉 친절일 뿐인 사소한 람다에는 사용이 가능합니다.
강 유형 Enum
Enum 클래스는 항상 일반 Enum 이든 UENUM 이든 구식 네임스페이스 Enum 을 대체하여 사용해야 합니다. 예:
// Old enum UENUM() namespace EThing { enum Type { Thing1, Thing2 }; } // New enum UENUM() enum class EThing : uint8 { Thing1, Thing2 };
이들은 uint8 기반인 한 UPROPERTY 로 지원되기도 하며, 구형 TEnumAsByte<> 우회법을 대체합니다:
// Old property UPROPERTY() TEnumAsByte<EThing::Type> MyProperty; // New property UPROPERTY() EThing MyProperty;
플래그로 사용되는 Enum 클래스는 새로운 ENUM_CLASS_FLAGS(EnumType) 매크로를 사용하여 비트단위 연산자 전부를 자동 정의합니다:
enum class EFlags { None = 0x00, Flag1 = 0x01, Flag2 = 0x02, Flag3 = 0x04 }; ENUM_CLASS_FLAGS(EFlags)
여기에 한 가지 예외라면, 'truth' 컨텍스트에서 플래그를 사용하는 것인데, 이는 언어상의 한계입니다. 그 대신, 모든 플래그 Enum 에 비교용으로 0 설정된 None Enum 을 넣도록 합니다:
// Old if (Flags & EFlags::Flag1) // New if ((Flags & EFlags::Flag1) != EFlags::None)
이동 시맨틱
모든 주요 컨테이너 유형, TArray, TMap, TSet, FString 에는 move 생성자와 move 할당 연산자가 있습니다. 이러한 유형의 값을 전달/반환할 때 종종 자동으로 사용되지만, std::move 의 UE4 해당 버전인 MoveTemp 를 통해 명시적으로 실행 가능합니다.
값으로 컨테이너나 스트링을 반환하는 것은, 보통 임시로 복사하는 비용 없어 표현성에 이득이 될 수 있습니다. 값 전달 관련 규칙 및 MoveTemp 사용법은 아직도 확립중이지만, 최적화된 코드베이스 영역 일부에서는 이미 찾아볼 수 있습니다.
디폴트 멤버 이니셜라이저
디폴트 멤버 이니셜라이저는 클래스 자체 내 클래스 기본 값을 정의하는 데 사용할 수 있습니다:
UCLASS() class UTeaOptions : public UObject { GENERATED_BODY() public: UPROPERTY() int32 MaximumNumberOfCupsPerDay = 10; UPROPERTY() float CupWidth = 11.5f; UPROPERTY() FString TeaType = TEXT("Earl Grey"); UPROPERTY() EDrinkingStyle DrinkingStyle = EDrinkingStyle::PinkyExtended; };
코드를 이런 식으로 작성했을 때의 장점은 다음과 같습니다:
-
여러 생성자에 걸쳐 이니셜라이저를 복제할 필요가 없습니다.
-
초기화 순서와 선언 순서가 섞일 일이 없습니다.
-
멤버 유형, 프로퍼티 플래그, 기본 값이 모두 한 곳에 있어, 가독성과 유지보수성에 좋습니다.
하지만 단점도 있습니다:
-
기본 값을 변경하면 모든 종속 파일을 리빌드해야 합니다.
-
헤더는 엔진 패치 릴리즈에서 변경할 수 없으므로, 가능한 픽스 종류가 제한될 수 있습니다.
-
이런 방식으로 모든 것을 초기화시킬 수는 없습니다. 예로 베이스 클래스, UObject 서브오브젝트, 앞서 선언한(forward-declared) 유형으로의 포인터, 컨스트럭터 인수에서 추론해 낸 값, 여러 단계에 걸쳐 초기화된 멤버 등입니다.
-
헤더에 이니셜라이저를 조금 두고, 나머지는 .cpp 파일의 생성자에 두게 되면 가독성과 유지보수성에 좋지 않을 수 있습니다.
실제 사용할지 여부는 적절한 판단에 맡길 부분입니다. 경험적으로, 디폴트 멤버 이니셜라이저는 엔진 코드보다 게임 코드 쪽에 적합합니다. 기본 값에 환경설정 파일을 사용하는 것도 고려해 보세요.
써드 파티 코드
엔진에서 사용하는 라이브러리에 코드를 수정할 때마다, 변경내용에 //@UE4 코멘트는 물론 왜 변경했는지에 대한 설명이 되는 태그를 꼭 달아주세요. 그래야 그 라이브러리의 새 버전으로 변경내용을 병합하는 작업이 쉽게 이루어지며, 라이선시 역시 우리가 가한 수정 내용을 쉽게 찾을 수 있습니다.
그리고 엔진에 포함되는 써드 파티 코드는 쉽게 검색되는 포맷의 코멘트로 마킹해야 합니다. 예:
// @third party code - BEGIN PhysX #include <PhysX.h> // @third party code - END PhysX // @third party code - BEGIN MSDN SetThreadName // [http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx] // Used to set the thread name in the debugger ... //@third party code - END MSDN SetThreadName
코드 포맷
대괄호 { }
대괄호 전쟁은 신물이 날 정도입니다. 때문에 에픽에서는 새 줄에 괄호를 넣는 것이 오래된 관행처럼 이어져 오고 있으니, 가급적 준수하여 주시기 바랍니다.
단일 문장 블록도 항상 대괄호를 포함시켜 주세요, 예:
if (bThing) { return; }
If - Else
if-else 문의 각 실행 블록은 대괄호로 묶어야 합니다. 이는 편집상의 실수를 방지하기 위함으로, 대괄호를 사용하지 않은 경우 다른 사람이 의도치 않게 if 블록에다 다른 줄을 추가하게 될 수가 있습니다. if 문의 영향을 받지 말아야 할 줄이라면 안좋은 일이겠지요. 더욱 안좋은 예라면 조건에 따라 컴파일되는 항목이 if/else 문을 깨지게 만드는 것입니다. 그러니 항상 대괄호로 묶어 주시기 바랍니다.
if (HaveUnrealLicense) { InsertYourGameHere(); } else { CallMarkRein(); }
여러 갈래 if 문에서 각각의 else if 문은 첫 번째 if 문과 같은 양만큼 들여써 줘야 합니다. 그래야 읽는 사람이 구조를 쉽게 이해할 수 있습니다:
if (TannicAcid < 10) { UE_LOG(LogCategory, Log, TEXT("Low Acid")); } else if (TannicAcid < 100) { UE_LOG(LogCategory, Log, TEXT("Medium Acid")); } else { UE_LOG(LogCategory, Log, TEXT("High Acid")); }
탭
-
실행 블록별로 코드를 들여쓰세요.
-
줄 시작부분의 공백은 스페이스가 아니라 탭을 사용해 주시구요. 그래도 탭을 스페이스 몇 칸으로 지정했는지와 무관하게 코드 줄을 맞추기 위해 스페이스를 써야 할 때가 있습니다. 이를테면 탭 이외의 캐릭터에 코드 줄을 맞출 필요가 있을 때겠지요.
-
C# 으로 코드를 작성하신다면 공백이 아니라 탭을 사용해 주시기 바랍니다. C# / C++ 사이의 전환은 프로그래머에게 자주 있는 일이고, 대부분은 그 탭 설정에 일관성이 있기 때문입니다. Visual Studio 기본값으로는 C# 파일에 공백을 사용하고 있으니, 언리얼 엔진 코드 작업을 할 때는 이 세팅을 바꿔줘야 한다는 점 기억해 주시기 바랍니다.
Switch 문
빈 case 를 제외하고 (똑같은 코드를 갖는 다중 케이스의 경우), switch case 문에서는 다음 케이스로 넘어가는지를 명시적으로 밝혀줘야 합니다. 각각의 경우마다 break 를 넣던가, fall through 코멘트를 달아 주세요. 다른 코드 제어-이동 명령(return, continue 등)도 괜찮습니다.
default 케이스는 항상 만들어 두시고, 다른 사람이 그 디폴트 뒤에 새로운 케이스를 추가할 때에 대비해 break 도 넣어 두시기 바랍니다.
switch (condition) { case 1: ... // falls through case 2: ... break; case 3: ... return; case 4: case 5: ... break; default: break; }
네임스페이스
네임스페이스(Namespace)는 아래 규칙만 준수한다면 클래스, 함수, 변수의 체계를 적절히 잡는 데 사용할 수 있습니다.
-
언리얼 코드는 현재 글로벌 네임스페이스에 쌓여있지 않습니다. 전영 범위에서의 충돌을, 특히나 써드 파티 코드를 끌어들일 때는 주의를 기울여야 합니다.
-
전역 범위에는 "using" 선언을, .cpp 파일에서도 넣지 마시기 바랍니다 ("unity" 빌드 시스템에 문제가 생깁니다).
-
다른 네임스페이스 안이나 함수 본문 안에서는 "using" 선언을 넣어도 괜찮습니다.
-
참고로 네임스페이스 안에서 "using" 을 사용한다면, 동일 이동 단위 내의 또다른 해당 네임스페이스로 이어지게 됩니다. 일관되기만 하다면야 괜찮기는 합니다.
-
위의 규칙을 따른다면 헤더 파일에서만은 안전히 "using" 을 사용할 수 있습니다.
-
참고로 앞서 선언된 형은 각각의 네임스페이스 안에서 선언해 줘야 하며, 그렇지 않으면 링크 오류가 납니다.
-
한 네임스페이스 안에 다수의 클래스/유형을 선언하면, 다른 전역 범위의 클래스에서 사용하기가 어려워 집니다 (이를테면 함수 시그너처는 클래스 선언에 나타날 때 명시적 네임스페이스를 사용해야 합니다).
-
(using Foo:FBar 과 같이) "using" 을 사용해서 네임스페이스 안의 특정 변수만 자신의 범위로 에일리어싱할 수도 있습니다만, 언리얼 코드에서는 보통 그렇게 하지 않습니다.
-
언리얼 헤더 툴에는 네임스페이스가 지원되지 않으므로, UCLASS, USTRUCT 등을 정의할 때는 사용할 수 없습니다.
물리적 종속성
-
파일 이름은 가급적 접두사를 붙이지 않는 것이 좋습니다. 예를 들면 UnScene.cpp 보다는 Scene.cpp 가 좋습니다. 그래야 Workspace Whiz 나 Visual Assist 같은 툴에서 Open File in Solution 같은 기능을 사용할 때, 원하는 파일을 명확히 구분해 내는 데 필요한 글자수를 줄이는 등 사용하기가 용이해 집니다.
-
모든 헤더는 #pragma once 디렉티브(지시자)로 복수의 include 를 방지해야 합니다. 참고로 요즘 사용하는 모든 컴파일러는 #pragma once 를 지원합니다.
#pragma once <파일 내용물>
-
일반적으로는 물리적 결합을 최소화시켜 보세요. 헤더 include 대신 앞선 선언이 가능하면, 그리 하세요. 가급적이면 세세한 부분을 include 하세요. Core.h 를 include 하지 마시고, Core 의 헤더 중 정의가 필요한 특정 부분을 include 시키세요.
-
세세한 include 작업을 쉽게 하기 위해, 필요한 헤더는 전부 직접 include 해 주세요. 자신이 include 시킨 다른 헤더를 간접적으로 include 시키는 헤더에 의존하지 마세요. 다른 헤더를 통해 include 시키는 것 보다는, 필요한 것을 전부 include 하세요.
-
모듈에는 Private 와 Public 소스 디렉터리가 있습니다. 다른 모듈이 필요로 하는 정의는 Public 디렉터리의 헤더에 있어야 하나, 그 외 모든 것은 Private 디렉터리에 있어야 할 것입니다. 참고로 구형 언리얼 모듈의 경우 이 디렉터리는 Src 와 Inc 로 불리기도 하는데, 이름만 그렇다 뿐 같은 방식으로 프라이빗 코드와 퍼블릭 코드를 구분하기 위함일 뿐이지, 헤더 파일을 소스 파일과 구분하기 위함은 아닙니다.
-
미리컴파일된 헤더 생성용 헤더 셋업에 대해서는 걱정하지 마세요. UnrealBuildTool 이 더욱 잘 처리해 줄 것입니다.
-
큰 함수는 논리적 하위 함수로 나눕니다. 컴파일러 최적화 중 한 분야가 공통 하위 표현식 삭제인데, 함수가 클 수록 그 식별을 위해 컴파일러가 할 일이 많아지므로, 빌드 시간이 크게 늘어나게 됩니다.
-
인라인 함수는 분별있게 사용해야 하는데, 사용하지 않는 파일에 있어도 강제로 리빌드시키기 때문입니다. 인라인은 사소한 접근자에만, 또는 프로파일링을 통해 이득이 있는 것으로 보일때만 써야 합니다.
-
FORCEINLINE 사용에 있어서는 조금 더 보수적이어야 합니다. 모든 코드와 로컬 변수는 호출하는 함수로 확장되어, 큰 함수에서 발생하는 것과 동일한 빌드 시간 문제가 생깁니다.
캡슐화
보호 키워드로 캡슐화 시키세요. 클래스 멤버는 클래스의 public/protected 인터페이스 일부가 아닌 다음에야 거의 항상 private 으로 선언해야 합니다. 상황에 따라 판단을 잘 하시되, 접근자가 없으면 나중에 기존 프로젝트와 플러그인 해체 없이 리팩터링 작업을 하는 것이 힘들어 진다는 점 염두에 둬 주시기 바랍니다.
특정 칸은 파생 클래스에서만 사용하도록 의도된 경우, private 로 만들어 보호된 접근자를 제공해 주시기 바랍니다.
더이상 파생시킬 클래스가 아닌 경우 final 을 사용하세요.
일반적인 스타일 문제
-
종속성 거리를 최소화하세요. 코드가 특정 값을 갖는 변수에 의존할 때는, 변수를 사용하기 직전에 그 값을 설정해 보도록 하세요. 실행 블록 상단에 변수 값을 초기설정해 둔 상태로 코드 수백 줄 동안 사용하지 않는다면, 그 종속성을 모르는 사람이 그 값을 바꾸게 될 여지가 많이 있습니다. 바로 다음 줄에 사용한다면 변수 초기설정을 왜 그렇게 했는지, 어디서 사용되는지를 명확히 알 수 있는 것입니다.
-
메서드는 가급적 서브-메서드로 분할하세요. 인간은 세밀한 부분부터 시작해서 큰 그림을 재구성하기 보다는, 큰 그림을 먼저 그린 후 흥미를 끄는 세밀한 부분으로 파내려가는 것을 더 잘합니다. 마찬가지로, 모든 코드가 통째로 들어있는 메서드 보다는, 이름을 잘 지어둔 다수의 서브-메서드를 연속적으로 호출하는 단순한 메서드를 이해하기가 수월합니다.
-
함수 선언이나 함수 호출 위치에서 함수의 이름과 인수 목록에 선행되는 괄호 사이에 공백을 두지 마세요.
-
컴파일러 경고에 주의를 기울여 주세요. 컴파일러 경고 메시지는 무언가 잘못되었다는 것을 뜻합니다. 컴파일러의 고민에 귀를 기울여 주세요. 전혀 그럴 수가 없다면 #pragma 를 억제시키면 되긴 하는데, 이는 최후의 방법입니다.
-
파일 끝에 빈 줄을 하나 놔두세요. 모든 .cpp 와 .h 파일은 빈 줄이 있어야 gcc 에 제대로 돌아갑니다.
-
절대 float 가 int32 로 묵시적 변환되도록 하지 마세요. 연산이 느릴 뿐만 아니라 모든 컴파일러에서 컴파일되지도 않습니다. 그 대신 항상 appTrunc() 함수를 사용하여 int32 로 변환하세요. 여러 컴파일러에 대한 호환성이 높아질 뿐만 아니라 더 빠른 코드가 생성됩니다.
-
Interface (접두사 "I") 클래스는 항상 추상(abstract) 상태여야 하며 멤버 변수를 가져서는 안됩니다. Interface 는 순수 가상이 아닌 메서드, 심지어 가상이 아니거나 스태틱인 메서드도 내부적으로(inline) 구현하지 않는 한 포함시킬 수 있습니다.
-
디버그 코드는 유용하며 잘 다듬어진 상태거나, 체크인을 하지 않거나 중 하나여야 합니다. 디버그 코드가 다른 코드와 섞이면 다른 코드 읽기가 훨씬 힘들어 집니다.
-
스트링 리터럴 주변에는 항상 TEXT() 매크로를 사용하세요. 그러지 않으면, 코드가 리터럴에서 FString 을 생성하는 경우 원치 않는 스트링 변환 프로세스가 유발됩니다.
-
루프에서의 동일 작업 반복을 피하세요. 공통된 하위 표현식은 루프에서 끌어올려 중복 계산을 피합니다. 어떤 경우에는 statics 를 활용하여 전역 범위에서의 함수 호출을 대상으로 하는 중복 작업을 피할 수 있는데, 스트링 리터럴에서의 FName 생성같은 경우를 예로 들 수 있습니다.
-
핫 리로드 기능을 염두에 두세요. 종족성을 최소화시켜 반복처리 시간을 줄입니다. 리로드 동안에 변할 확률이 있는 함수에는 인라인 또는 템플릿을 사용하지 마세요. 리로드 동안 그대로 남아있을 듯한 것에만 statics 를 사용하시기 바랍니다.
-
복잡한 표현식은 중간 변수를 사용하여 단순화시키세요. 복잡한 표현식을, 부모 표현식 내에서 그 의미가 잘 설명되도록 이름지은 작은 표현식들을 가진 중간 변수에 할당된 하위 표현식으로 나눌 수 있다면, 이해하기가 수월해질 것입니다. 예를 들어:
if ((Blah->BlahP->WindowExists->Etc && Stuff) && !(bPlayerExists && bGameStarted && bPlayerStillHasPawn && IsTuesday()))) { DoSomething(); }
이런 코드는 다음으로 갈음합니다:
const bool bIsLegalWindow = Blah->BlahP->WindowExists->Etc && Stuff; const bool bIsPlayerDead = bPlayerExists && bGameStarted && bPlayerStillHasPawn && IsTuesday(); if (bIsLegalWindow && !bIsPlayerDead) { DoSomething(); }
참고로 override 키워드는 최근에 추가된 관계로 이를 지키지 않은 코드가 많이 있는데, 편할 때 그런 코드에다 이 override 키워드를 추가해야 주면 좋을 것입니다.
출처 : 언리얼 코딩표준
