Development Convetion - Tiny-Metro/Poly-Metro GitHub Wiki

개발에 사용할 변수, 파일명 등의 Convention입니다.

기존 회의에서 이미 정해놓은 Convention이 있지만, UE에서 사용하는 것이 기존과는 다르므로 재정의 하도록 하겠습니다.

• 변수는 카멜 및 헝가리안 표기법 사용

  int camelCase;
  std::string strHungarianCase;
  

• 함수는 파스칼 표기법 사용

  void PascalCase() { }
  

• 변수, 함수, 클래스, 구조체, enum에 파스칼 표기법 사용

  class MyClass {
  public:
    void MyFunction();
  
  protected:
    int32 MyValue;
  }
  

• 예외 : HUD등 변수명을 강제하는 상황에서는 카멜 표기법 사용

  btnSomething
  imgSomething
  // etc
  

• 매크로 및 enum은 대문자와 언더바(_) 사용

  #define THIS_IS_MACRO 1234;
  enum COLOR {
      COLOR_BLACK,
      COLOR_WHITE
  };
  

• 매크로는 대문자와 언더바(_) 사용

  #define THIS_IS_MACRO 1234;
  

• 한 줄 짜리 조건문, 반복문에도 중괄호 사용하기

  if(isValid) {
      // Logic
  }
  for(auto i : arr) {
      // Logic
  }
  

• 함수 시작 중괄호는 붙여서 사용

  int main() {
      // Logic
      return 0;
  }
  

• C++파일 외의 파일에는 접두사 사용

  • Blueprint = BP
  • Static Mesh = SM
  • Sound Effect = SE
  • 예외 : Level (접두사 없음)
  • 그 외 : 상의 후 결정

• 파일명에는 파스칼 표기법 사용

  • ex) BP_Camera
  • ex) SM_StationCircleInner
  • ex) TinyMetroSeoul (Level)

• 브랜치 컨벤션

  • master : 배포 가능한 버전
  • develop : 개발 완료된 기능들을 머지해둘 브랜치
  • feature : 개발중인 feature를 나눌 브랜치
    • feature/{feature_name}/#{issue_number}의 형태로 분리
  • develop-{Feature}: 개발중인 feature를 나눌 브랜치
    • develop에서 브랜치를 생성하여, develop-{Feature Name}의 형태로 작성
    • {Feature Name}은 대문자와 언더바(_)를 조합하여 사용합니다.
      • ex)develop-GridManager