[UE] 언리얼 엔진 코딩 컨벤션(Coding Convention)

언리얼엔진(UE)

[UE] 언리얼 엔진 코딩 컨벤션(Coding Convention)

2h1824 2025. 1. 23. 21:38

코딩 컨벤션(Coding Convention)

유지보수하기 쉬운 코드를 작성하기 위한 일종의 코딩 스타일 규약

실제로 프로젝트를 진행할 때, 코드 작성은 항상 다른 사람과의 협업을 베이스로 생각해서 작성해야 한다. 특히 이번에 소규모 팀프로젝트를 진행하는 과정에서 코딩 컨벤션을 정하지 않으면 발생할 수 있는 문제나 에로사항들을 겪고 보니 기업에서 대규모의 팀단위로 이루어지는 프로젝트에서는 문제가 정말 크겠다는 생각이 들었다. 이런 협업이라는 특성 때문에 우리는 코딩 컨벤션이라는 표준 및 모범 사례를 준수할 수 있도록 프로젝트나 산업 내에서 정해진 코딩 스타일 규약을 따르는 것이 좋다. 이러한 코딩 컨벤션의 필요성 때문에 언리얼 엔진 공식 문서에서 제공하는 코딩 표준에 대해 알아봤다.

코딩 컨벤션의 필요성

소프트웨어의 총 수명 비용 중 80%가 유지보수에 소모
최초 작성자가 해당 소프트웨어를 끝까지 유지보수하는 경우는 거의 없음
코딩 컨벤션을 사용하면 코드의 가독성 향상 → 코드를 이해하는 시간 감소 및 이해도 상승
대다수의 코딩 컨벤션이 크로스 컴파일러 호환성에 필요

1. 저작권 고지

에픽게임즈에서 제공한 모든 소스 파일은 파일 첫 번째 줄에 저작권을 고지해 줘야 한다. 언리얼 엔진에서 제공한 소스 파일에는 좌측 사진과 같이 고지가 되어 있고, 언리얼 엔진 프로젝트에서 만든 클래스의 소스코드에는 우측 사진처럼 주석으로 저작권 고지를 해달라는 주석이 있다.

2. 클래스 작성 시 유의 사항

작성자보다 읽는 사람을 염두에 두고 작성해야 하니 보통 인터페이스가 위치하게 되는 public 부분을 private 부분보다 먼저 작성하는 것이 좋다.

3. 네이밍 컨벤션 (명명 규칙)

파스칼 케이스 사용 → 단어의 첫 글자를 대문자로 표시
ex) TestWord
언더바('_') 사용 금지
타입 이름에는 추가적으로 대문자로 접두사를 포함
- 템플릿 클래스 접두사 T → class TAttribute
- UObject 상속하는 클래스 접두사 U → class UActorComponent
- AActor 상속하는 클래스 접두사 A → class AActor
- Swidget 상속하는 클래스 접두사 S → class SCompoundWidget
- 추상적 인터페이스 클래스 접두사 I → class IAnlyticsProvider
- 열거형 접두사 E → enum class EColorBits
- 부울 변수 접두사 b → bHasFadedIn
- 그 외 대부분 접두사 F
부울을 반환하는 모든 함수는 IsVisible()과 같이 의문문 형태로 작성
함수 파라미터가 레퍼런스로 전달되어 파라미터 변경 사항이 함수가 종료되어도 사용되면 접두사 Out 권장
입력으로만 사용되면 접두사 In
In, Out 둘다 해당한다면 InOut