[📚정보] 입문자를 위한 유니티의 표준 네이밍 컨벤션

[익명(211.225)]

팀 단위로 개발하다 보면 클래스명, 변수명 등등 코드에 사용되는 이름을 어떻게 짓는지가 가독성과 유지보수에 적지않은 영향을 미치는 경우가 있다.

때문에 클래스나 메서드, 변수 등에 사용되는 이름의 명명법을 규칙으로 만들어 관리할 필요가 생기는데, 이를 네이밍 컨벤션, 혹은 네이밍 룰이라고 한다.

네이밍 컨벤션은 팀 단위의 규칙이기 때문에 당연히 팀마다 크고작은 부분이 다른데, 팀에서 채택한 컨벤션이 본인이 써온 방식과 다르더라도 협업을 위해 컨벤션을 따르도록 하자.

본인이 공부하는 입장이고 본인만의 컨벤션이 없는 상황이라면 유니티와 C#에서 제시하는 표준 네이밍 컨벤션을 익혀두는 것이 좋다. 표준인 만큼 대부분 이를 골자로 적절히 변형시킨 컨벤션을 사용하며, 유니티나 C#에서 제공하는 공식 문서나 소스 코드는 거의 대부분 자기네가 제시한 네이밍 컨벤션을 따르고 있다.

# case의 종류

1. PascalCase(파스칼 케이스) - 각 단어의 첫 글자를 대문자로, 그 외에는 소문자로 표기하는 방법. UpperCamelCase라고도 함.

2. camelCase(카멜 케이스) - 소문자를 사용하되, 두 번째 단어부터는 각 단어의 첫 글자를 대문자로 표기하는 방법. 파스칼 케이스(UpperCamelCase)와 구분할 때는 lowerCamelCase로 칭하기도 한다.

3. snake_case(스네이크 케이스) - 각 단어 사이를 _(언더바)로 구분하여 표기하는 방법. 대소문자를 섞어 쓰는 위 표기법들과 다르게 모두 소문자만을 사용하든지 혹은 모두 대문자만을 사용하는 게 주된 표기법. ex) SNAKE_CASE, snake_case

4. kebab-case(케밥 케이스) - 각 단어 사이를 -(하이픈)으로 구분하여 표기하는 방법.

5. Hungarian Notation(헝가리안 표기법) - 변수명 앞에 타입 등 변수의 용도나 자료형 등을 소문자 접두사로 붙이는 방법. 장점에 비해 가독성 저해 등 단점이 부각되면서 최근에는 배척되는 추세지만 여전히 팀에 따라 채택하기도 함. ex) strName, iCount

# 유니티의 표준 네이밍 컨벤션

1. 클래스는 명사를 사용하고, Pascal Case로 표기한다.

ex) PlayerController

2. 인터페이스는 Pascal Case로 표기하고, I 접두사를 붙인다.

ex) IEnumerator

3. 메서드는 동사를 사용하고, Pascal Case로 표기한다.

ex) DeleteObject, GetHp

4. 변수명에는 명사를 사용하고, 약어 사용을 지양하며 의미있는 이름을 사용한다.

의미있는 이름을 사용하라는 말은 n, i 등의 명명을 지양하고 누가 봐도 이 변수의 사용 의도와 용도를 알 수 있게 명명하라는 뜻이다.

다만 for문에서 단순 반복만을 위해 사용되는 경우라든지 일부 예외는 있는데, for문에서도 배열 인덱스에 접근할 때는 index로 명명하는 등 유의미한 변수명을 사용하는 게 좋다.

4.1. public 멤버 변수인 경우 Pascal Case로 표기하고, 되도록 프로퍼티(속성)를 사용한다.

ex) WalkSpeed

c#에서 프로퍼티는 특정 field(개발자가 따로 수정하지 않으면 자동으로 backing field가 생성된다)에 대한 get set 메서드를 호출하는 식이기 때문에 멤버 변수를 직접 통하는 것에 비해 퍼포먼스에서 차이가 있을 수는 있다.

그러나 은닉성을 보장하는 등 단순 공용 변수를 사용하는 것보다 객체지향적이다.

4.2. private 멤버 변수인 경우 camel Case로 표기하고, _(언더바)나 m_ 등의 접두사를 붙인다.

ex) _strength

접두사를 붙이는 이유는 지역 변수와의 혼동을 방지하기 위한 목적이다.

예를 들어 메서드 내에서 strength라는 이름의 지역 변수를 선언해 사용해야 할 일이 있는데 멤버 변수 중에도 strength라는 이름의 변수가 있다고 가정할 때, 해당 메서드 내에서 멤버 변수를 가져오려면 this 키워드를 이용해 객체의 멤버 변수를 호출하는 것임을 명확하게 해줘야 하고(this.strength), 코드를 리뷰할 때 멤버 변수를 가리키는 것인지 지역 변수를 가리키는 것인지 헷갈릴 수 있다.(ide에서 하이라이팅을 해준다고는 하지만)

이때 멤버 변수에 접두사를 붙여 _strength로 명명한다면 멤버 변수를 가리킨다는 것을 명확히 알 수 있는 것은 물론이고 번거롭게 this 키워드를 이용하지 않아도 된다.

접두사는 _ 또는 m_이 권장되는데, 유니티뿐만 아니라 c# 전반적으로 m_보다는 _만 붙이는 게 주로 사용되는 것으로 알고 있음

4.3. 지역 변수는 camel Case로 표기한다.

ex) rotateSpeed

4.4. bool 타입 변수는 is, can, has 등의 접두사를 사용해 표기한다.

ex) isRunning, canWork, hasChildren

bool 타입 변수는 거의 대부분 특정 조건에 따라 분기하는 목적으로 사용되는데, 이때 위와 같이 명명하면 용도를 명확하게 해주고 가독성을 향상시킨다.

예를 들어 대상이 죽었는지 아닌지를 확인하고 싶다고 가정하자.

1) if (target.DeadFlag)

2) if (target.IsDead)

대충 봐도 1) 보단 2)가 더 명확한 의미를 갖고 있고 용도에 부합하는 명명법이라는 것을 알 수 있다.

5. enum은 명사를 사용하고, Pascal Case로 표기한다. 열거형의 각 멤버도 Pascal Case로 표기한다.

ex) WeaponType

# 참고 링크

유니티 표준 네이밍 컨벤션: https://unity.com/kr/how-to/naming-and-code-style-tips-c-scripting-unity

C# 표준 네이밍 컨벤션: https://learn.microsoft.com/ko-kr/dotnet/csharp/fundamentals/coding-style/coding-conventions

[익명(14.52)]

간혹 보면 유니티쪽 코드에서 퍼블릭 프로퍼티를 카멜로 쓰기도 하더라.

[익명(211.225)]

대표적으로 transform...

[아이스말차라떼(icedmatchalatte)]

카멜이 더 자연스러운 경우가 있는거 같음. 구조체의 퍼블릭 멤버변수도 그렇고

[카퍠인(happys96)]

[익명(49.161)]

[익명(211.196)]

enum 파스칼이었구나 전처리기 마냥 어퍼 스네이크로 했는데