Code Convention

출처

언리얼 엔진을 위한 에픽 C++ 코딩 표준 | 언리얼 엔진 5.5 문서 | Epic Developer Community

주요 코드 컨벤션

모든 소스 파일 첫 줄에 저작권 고지하기!
- 무조건 다음 한 줄을 최상단에 추가해 주세요!
```
// Copyright Epic Games, Inc. All Rights Reserved.
```
  - 이게 누락되면 언리얼 쪽 툴에서 에러가 납니다! 무조건 준수!
파일 및 클래스 명
- 클래스가 포함된 파일을 클래스명과 동일하게 작성
- 헤더 상단에 가드 (#pragma once) 무조건 추가
- 헤더와 cpp 파일 분리
네임스페이스
- 헤더에서는 using namespace std; 사용 금지
공백
- 연산자 공백 a+b → a + b 처럼 연산자 주변에 공백 넣기
- 쉼표 뒤 공백 넣기 func(a, b, c) 처럼 쉼표 뒤에는 공백 추가
중괄호
- 조건문 등 중괄호를 사용해야 하는 부분에서는 무조건 개행 이후 중괄호 사용.
- Body가 한 줄이어도 무조건 중괄호 사용.
주석 달기
- 다른 사람이 봤을 때 이게 뭐임? 하는 소리가 나오지 않도록 복잡하거나 특수한 경우에 주석 추가하기.
const 붙이기
- 함수 파라미터나 멤버 함수에서 수정되지 않는 값에는 const를 붙이기.
함수 이름 명명 규칙
- 함수 이름은 동사 중심으로 해주세요!
- MoveActor(), SpawnParticle() 처럼 의미 전달이 확실하도록요!
- 함수는 Pascal Case로 선언. e.g. calculateSum() → CalculateSum()
변수 이름
- 변수 이름은 해당 변수가 갖는 값을 명확하게 인지할 수 있는 이름으로 선언.
- Bool Type 변수는 변수명 앞에 접두어 b 붙이기. e.g. bool bIsRun
- Int Type 변수는 int → int32 사용.
- 변수, 매개변수는 Pascal case로 선언. e.g. int32 vectorSum → int32 VectorSum
- 반환 타입은 명시적으로 작성 auto 사용은 필요할 때만, 가급적 명시하는 방향으로 작성
bool을 반환하는 함수 → ‘질문 형태’로 명명하기!
- IsReady(), CanSpawn(), ShouldDelete() 처럼 true/false의 의미가 명확하게 드러나야죠!
- CheckReady()처럼 결과가 참인지 거짓인지 함축적이면, 호출하는 사람이 헷갈릴 수 있어요.
- 들여쓰기는 탭(Tab)을 쓰기!
  - 들여쓰기: 스페이스 대신 탭을 사용 (Visual Studio나 IDE에서 탭 크기를 4로 설정).
- 중괄호는 어지간하면 꼭 사용 & 새 줄에 쓰기!
  - 중괄호 { }는 if/for 등 모든 구문에서 반드시 사용하고, 새 줄에 두세요.
```
if (Condition)
{
    DoSomething();
}
else
{
    DoSomethingElse();
}
```
- Switch문에선 case마다 break 혹은 ‘falls through’ 표기하기!
  - default 구문도 빠짐없이 작성하기!
  - 빈 케이스(중복 케이스)가 아니라면 반드시 break;나 return; 같이 종료 구문을 써 주세요.
  - 의도적으로 케이스를 2개 이상 거쳐야 할 때는 꼭 // falls through 표기를 해주세요!
    - falls through(폴스루)는 특정 case문 다음에 break를 생략했을 때 발생하는 현상이에요!
    - 이렇게 하면 의도적으로 여러개의 case문을 실행시킬 수 있어요!
```
switch (Value)
{
    case 1:
        // falls through
    case 2:
        ...
        break;
    default:
        break;
}
```
- 주석을 적을 땐 “왜”와 “무엇을” 설명하기!
  - 코드는 최대한 ‘어떤 일을 하는지’가 드러나도록 작성하는게 좋습니다!
  - 코멘트는 ‘왜 이런 처리를 하는지’, ‘이 로직이 무엇을 의미하는지’를 적어주세요.
  - 너무 당연한 코드는 설명할 필요 없고, 의도를 명확히 해야 하는 부분에만 코멘트를 집중하는 것으로요!
- 불필요한 auto(자동 타입 추론) 사용 자제하기!
  - C++에서 auto를 막 쓰면, 코드를 읽는 사람이 타입을 쉽게 알 수 없어서 헷갈립니다.
  - 꼭 필요한(람다를 변수에 담거나, 복잡한 이터레이터 타입 등) 경우가 아니면, 직접 타입을 명시해주세요!
- for문을 사용할 땐 범위 기반 for 문을 적극 활용하기!
  - C++11 이상에서는 for (ElementType& Elem : Container) 식으로 깔끔하게 순회할 수 있어요.
  - 인덱스가 필요 없고, 단순 반복일 때는 range-based for가 가독성이 좋아요.
```
TArray<int32> Numbers = {1, 2, 3};
for (int32 Num : Numbers)
{
    UE_LOG(LogTemp, Log, TEXT("Number: %d"), Num);
}
```
- const 철저히 사용하기!
  - 함수 파라미터나 멤버 함수에서 수정되지 않는 값에는 const를 붙여주세요.
  - 읽는 사람에게 “이 변수/함수는 변경되지 않아요!”라고 명시하는 것만으로도 코드 파악이 훨씬 빨라져요.
- 네이밍은 명확하고 간결하게!
  - 변수, 함수, 클래스 이름은 읽는 사람이 봐도 바로 이해가 가도록 짓습니다.
  - 줄임말이나 약어는 지양하고, 부득이하게 줄이는 경우에도 팀에서 합의된 표준을 따르세요.
    - e.g. LastUpdateTime은 LUT보다 훨씬 더 읽기 편하죠!

선언 순서

변수나 함수의 선언 순서는 virtual, 리플렉션, 일반 순서

class Test
{
	public:
		virtual void A();
		
		UFUNCTION()
		void B();
		
		void C();
		
	public:
		UPROPERTY()
		int32 D;
		
		float E;
}

접근 지정자

접근 지정자는 public, protected, private 순으로 선언

class Test
{
	public:
		void A();
	protected:
		void B();
	private:
		void C();
}

변수와 함수의 접근 지정자는 분리

class Test
{
	public:
		void A();
	protected:
		void B();
	private:
		void C();
		
	public:
		int32 D;
	protected:
		float E;
	private:
		bool bF;
}

출처

주요 코드 컨벤션

클린 코드에 대하여