* (유형이나 변수 등의) 이름 내 각 단어의 첫 글자는 대문자로 써야 하며, 단어 사이에 보통은 공백을 띄우지 않습니다. Health 와 UPrimitiveComponent 정도를 예로 들 수는 있지만, lastMouseCoordinates 나 delta_coordinates 같은 것은 아닙니다.
* 변수 이름과 구분하기 위해 유형 이름을 대문자 한 글자로 나타내는 접두사를 붙입니다. 예를 들어 FSkin 이 유형 이름이고, Skin 은 FSkin 의 인스턴스 입니다.
프로시져(반환값이 없는 함수)는 강한 동사 뒤에 오브젝트를 붙여 써야 합니다. 예외는 메소드의 오브젝트가 그 안에 있는 오브젝트일 때인데, 그런 경우 오브젝트는 맥락에서 이해를 합니다. "Handle" 이나 "Process" 같은 것으로 시작하는 이름은 애매하니 피해 주시기 바랍니다.
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 도 함수 바디에서 변경 불가능합니다.
}
여기에 한 가지 예라면 값 전달 파라미터는 궁극적으로 컨테이너 속에 이동될텐데 ("이동 시맨틱" 참고), 드문 경우일 것입니다.
저희는 JavaDoc 기반 시스템을 사용하여 코드에서 코멘트를 자동으로 추출한 뒤 문서를 만들기 때문에, 코멘트에는 따라야 하는 특수한 포맷 규칙이 몇 가지 있습니다.
다음 예제는 클래스, 스테이트, 메소드, 변수 코멘트의 포맷을 선보입니다. 기억하실 것은, 코멘트는 코드를 증강시켜야 합니다. 코드는 구현을 설명하고, 코멘트는 그 의도를 설명합니다. 코드 한 줄의 의도를 바꾸더라도 반드시 코멘트를 업데이트하시기 바랍니다.
참고로 지원되는 파라미터 코멘트 스타일은 두 가지로, Steep 와 Sweeten 메소드로 구체화되어 있습니다. Steep 이 사용하는 @param 스타일은 전형적인 스타일이지만, 단순 함수의 경우 파라미터 문서를 함수에 대한 설명 코멘트로 통합시키는 것이, Sweeten 예제에서 보듯이 더욱 깔끔할 수 있습니다.
메소드 코멘트는 딱 한번, 메소드가 공개적으로 선언되는 곳에 include 시켜야 합니다. 메소드 코멘트는 다른 호출자에게 관련이 있을 메소드 오버라이드 관련 정보를 포함해서, 메소드 호출자에 관련된 정보만을 담아야 합니다. 메소드 구현에 대한 세부사항이나 호출자에 관련이 없는 오버라이드는 메소드 구현 안에 코멘트를 달아야 할 것입니다.
언리얼 엔진은 다수의 C++ 컴파일러로 대규모 이식이 가능하도록 만들어 졌기에, 기능을 사용할 때는 지원하게 될 수도 있다고 생각되는 컴파일러와의 호환성을 신중히 따져 봅니다. 가끔은 매우 유용한 기능이라 매크로에 저장하여 많이 사용하는 경우도 있지만, 보통은 지원하게 될 거라 생각하는 모든 컴파일러가 최신의 표준을 지원할 때까지는 기다립니다.
범위 기반 for, 이동 시맨틱, 람다처럼 최신 컴파일러에서 잘 지원되는 것으로 보이는 C++ 11 언어 기능을 활용하고 있습니다. 어떤 경우에는 (컨테이너의 rvalue 레퍼런스같은) 전처리기 조건문에서 이러한 기능을 묶어 사용할 수 있도록 하고 있습니다. 그러나 새 플랫폼에서 문법을 소화시키지 못하여 혼란이 야기될 수 있는 기능에 대해서는, 확신이 들기 전까지 채택하지 않을 수 있습니다.
이에 대한 한 가지 예외라면, C++/CX 빌드(예: Xbox One)의 nullptr 은 사실 매니지드 널 레퍼런스 유형입니다. 유형이나 어떤 템플릿 인스턴스화 맥락을 제외하고는 네이티브 C++ 의 nullptr 과 거의 호환되므로, 호환성을 위해서는 좀 더 일반적인 decltype(nullptr) 대신 TYPE_OF_NULLPTR 매크로를 사용해야 합니다.
코드를 읽는 사람이 유형을 명확하게 알 수 있어야 한다는 것은 매우 중요합니다. 일부 IDE 에서 유형을 추론할 수는 있지만, 이는 코드가 안정적인 상태라는 가정하에서입니다. GitHub 같은 곳에서 개별 소스 파일을 독립적으로 확인하거나, merge/diff 툴을 사용하는 사람에게도 도움이 되지 않습니다.
auto 를 사용해도 괜찮다고 확실히 알고 있는 경우, 항상 해당 유형에 const, &, * 를 정확히 사용해야 한다는 점 기억해 주시기 바랍니다. 그렇게 해야 auto 를 통해 추론 유형을 원하는 유형으로 이끌어낼 수 있을 것입니다.
(Range Based For) 코드의 가독성과 유지보수성 향상에 도움이 되므로 사용을 추천합니다. 예전 TMap 이터레이터를 사용하는 코드를 이주할 때는, 예전 이터레이터 유형 메소드였던 Key() 와 Value() 함수가 이제 단순히 내재된 키-값 TPair 의 Key 와 Value 칸이 되었음에 유의하세요:
이제 람다(Lamda)는 모든 컴파일러에 사용할 수 있지만, 그 용법은 주의를 기울여야 합니다. 최적의 사용법은 길이상 두 구문 정도, 특히나 규모가 더 큰 표현식이나 구문의 일부로 사용될 때, 예를 들면 범용 알고리즘의 술부(predicates)에 사용될 때는 더욱 그러해야 합니다.
모든 주요 컨테이너 유형, TArray, TMap, TSet, FString 에는 move 생성자와 move 할당 연산자가 있습니다. 이러한 유형의 값을 전달/반환할 때 종종 자동으로 사용되지만, std::move 의 UE4 해당 버전인 MoveTemp 를 통해 명시적으로 실행 가능합니다.
값으로 컨테이너나 스트링을 반환하는 것은, 보통 임시로 복사하는 비용 없어 표현성에 이득이 될 수 있습니다. 값 전달 관련 규칙 및 MoveTemp 사용법은 아직도 확립중이지만, 최적화된 코드베이스 영역 일부에서는 이미 찾아볼 수 있습니다.
엔진에서 사용하는 라이브러리에 코드를 수정할 때마다, 변경내용에 //@UE4 코멘트는 물론 왜 변경했는지에 대한 설명이 되는 태그를 꼭 달아주세요. 그래야 그 라이브러리의 새 버전으로 변경내용을 병합하는 작업이 쉽게 이루어지며, 라이선시 역시 우리가 가한 수정 내용을 쉽게 찾을 수 있습니다.
if-else 문의 각 실행 블록은 대괄호로 묶어야 합니다. 이는 편집상의 실수를 방지하기 위함으로, 대괄호를 사용하지 않은 경우 다른 사람이 의도치 않게 if 블록에다 다른 줄을 추가하게 될 수가 있습니다. if 문의 영향을 받지 말아야 할 줄이라면 안좋은 일이겠지요. 더욱 안좋은 예라면 조건에 따라 컴파일되는 항목이 if/else 문을 깨지게 만드는 것입니다. 그러니 항상 대괄호로 묶어 주시기 바랍니다.
* 줄 시작부분의 공백은 스페이스가 아니라 탭을 사용해 주시구요. 그래도 탭을 스페이스 몇 칸으로 지정했는지와 무관하게 코드 줄을 맞추기 위해 스페이스를 써야 할 때가 있습니다. 이를테면 탭 이외의 캐릭터에 코드 줄을 맞출 필요가 있을 때겠지요.
* 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" 을 사용해서 네임스페이스 안의 특정 변수만 자신의 범위로 앨리어싱할 수도 있습니다만, 언리얼 코드에서는 보통 그렇게 하지 않습니다.
* 파일 이름은 가급적 접두사를 붙이지 않는 것이 좋습니다. 예를 들면 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 로 만들어 보호된 접근자를 제공해 주시기 바랍니다.
* *종속성 거리를 최소화하세요*. 코드가 특정 값을 갖는 변수에 의존할 때는, 변수를 사용하기 직전에 그 값을 설정해 보도록 하세요. 실행 블록 상단에 변수 값을 초기설정해 둔 상태로 코드 수백 줄 동안 사용하지 않는다면, 그 종속성을 모르는 사람이 그 값을 바꾸게 될 여지가 많이 있습니다. 바로 다음 줄에 사용한다면 변수 초기설정을 왜 그렇게 했는지, 어디서 사용되는지를 명확히 알 수 있는 것입니다.
* *메소드는 가급적 서브-메소드로 분할하세요*. 인간은 세밀한 부분부터 시작해서 큰 그림을 재구성하기 보다는, 큰 그림을 먼저 그린 후 흥미를 끄는 세밀한 부분으로 파내려가는 것을 더 잘합니다. 마찬가지로, 모든 코드가 통째로 들어있는 메소드 보다는, 이름을 잘 지어둔 다수의 서브-메소드를 연속적으로 호출하는 단순한 메소드를 이해하기가 수월합니다.
* 함수 선언이나 함수 호출 위치에서 함수의 이름과 인수 목록에 선행되는 괄호 사이에 공백을 두지 마세요.
* *컴파일러 경고에 주의를 기울여 주세요.* 컴파일러 경고 메시지는 무언가 잘못되었다는 것을 뜻합니다. 컴파일러의 고민에 귀를 기울여 주세요. 전혀 그럴 수가 없다면 #pragma 를 억제시키면 되긴 하는데, 이는 최후의 방법입니다.
* *파일 끝에 빈 줄을 하나 놔두세요.* 모든 .cpp 와 .h 파일은 빈 줄이 있어야 gcc 에 제대로 돌아갑니다.
* *절대 float 가 int32 로 묵시적 변환되도록 하지 마세요.* 연산이 느릴 뿐만 아니라 모든 컴파일러에서 컴파일되지도 않습니다. 그 대신 항상 appTrunc() 함수를 사용하여 int32 로 변환하세요. 여러 컴파일러에 대한 호환성이 높아질 뿐만 아니라 더 빠른 코드가 생성됩니다.
* Interface (접두사 "I") 클래스는 항상 추상(abstract) 상태여야 하며 멤버 변수를 가져서는 안됩니다. Interface 는 순수 가상이 아닌 메소드, 심지어 가상이 아니거나 스태틱인 메소드도 내부적으로(inline) 구현하지 않는 한 포함시킬 수 있습니다.
* 스트링 리터럴 주변에는 항상 TEXT() 매크로를 사용하세요. 그러지 않으면, 코드가 리터럴에서 FString 을 생성하는 경우 원치 않는 스트링 변환 프로세스가 유발됩니다.
* 루프에서의 동일 작업 반복을 피하세요. 공통된 하위 표현식은 루프에서 끌어올려 중복 계산을 피합니다. 어떤 경우에는 statics 를 활용하여 전역 범위에서의 함수 호출을 대상으로 하는 중복 작업을 피할 수 있는데, 스트링 리터럴에서의 FName 생성같은 경우를 예로 들 수 있습니다.
* 핫 리로드 기능을 염두에 두세요. 종족성을 최소화시켜 반복처리 시간을 줄입니다. 리로드 동안에 변할 확률이 있는 함수에는 인라인 또는 템플릿을 사용하지 마세요. 리로드 동안 그대로 남아있을 듯한 것에만 statics 를 사용하시기 바랍니다.
