[Unity] 유니티 코드 컨벤션

고현규·2023년 11월 7일

코드 컨벤션이란?

읽고 관리하기 쉬운 코드를 작성하기 위한 코딩 스타일 규약이다.


유니티 코드 컨벤션 규칙

1. 유니티 내부에서는 파스칼 표기법을 쓴다.

2. 클레스나 메소드 명등, 큰 덩어리에는 파스칼 표기법을 쓴다.

3. 함수 내부 파라미터나 변수는 카멜 표기법을 쓴다.

4. Non_public 변수명은 _ + 카멜 표기법을 쓴다.

5. 변수명은 딱 봐도 알아볼 수 있게 적는다.


변수명에 대한 표기법은 크게 4가지 정도 되지만,

주로 사용하는 파스칼 표기법과 카멜 표기법만 간단 하게 짚고 간다.

파스칼 표기법

  • 단어의 첫 시작은 항상 대문자
  • 이어지는 단어의 시작 또한 대문자
  • C#에서는 필드, 속성, 이벤트와 모든 메서드 및 로컬 함수에 사용한다.
public class ExampleEvents
{
    // A public field, these should be used sparingly
    public bool IsValid;

    // An init-only property
    public IWorkerQueue WorkerQueue { get; init; }

    // An event
    public event Action EventProcessing;

    // Method
    public void StartEventProcessing()
    {
        // Local function
        static int CountQueueItems() => WorkerQueue.Count;
        // ...
    }
}

카멜 표기법

  • 소문자로 시작하고 이어지는 단어의 시작은 대문자로 표기한다.
  • Java에서 주로 사용한다.
  • C#에서는 internal필드와 Non_public, 그리고 메서드 매개변수에 사용한다.
public class DataService
{
    private IWorkerQueue _workerQueue;
}

public class DataService
{
    private static IWorkerQueue s_workerQueue;

    [ThreadStatic]
    private static TimeSpan t_timeSpan;
}

public T SomeMethod<T>(int someNumber, bool isValid)
{
}

profile
게임 개발과 기획

0개의 댓글