TIL : 2024-09-26(목) :: GitHub 협업시 코드컨벤션

Q. 코드 컨벤션이란?

A. 협업시 코드를 어떤식으로 작성할건지 정하는 '약속' 이다.

개발 업무에서는 협업이 일상이기에 코드 컨벤션 만큼은 잘 지켜야한다.

 

Q. 코드 컨벤션을 쓰는 이유?

A.

1내 코드를 다른 사람이 쉽게 이해 할수 있도록
2.오랜 시간 뒤에 내가 내 코드를 알아보기 위해서
3.(중요) 취직하기 위해서
4.가독성

 

Q. 코드 컨벤션은 어떡해 쓰는건데?

A.

1.함수 중괄호 들여쓰기 방식

1-1.BSD 방식

Function()
{
  //CODE
}

1-2.K&R 방식

Function(){
  //CODE
}

 

2.코드컨벤션 규칙 :: 변수명을 정확히

//코드명을 목적에 맞춰서 이름만봐도 내용이 짐작이 되게 지어야한다.
Calss AScript (x) , Class TimeController (O)
float t (x) , float delayTime(O)
public float Get() (x) , public float GetDelayTime();

 

3.코드컨벤션의 종류
1.camelCase 소문자로 시작, 띄어쓰기 생략, 대문자로 구분
2.PascalCase 대문자로 시작, 띄어쓰기 생략, 대문자로 구분
3.snake_Case 소문자만 사용 ,띄어쓰기 대신 _ 사용
4.kebab-case 소문자만 사용 ,띄어쓰기 대신 - 사용

 

4.유니티에서의 컨벤션

유니티 엔진에서는  PascalCase 를 사용
하이어라키는 스페이스바를 허용하지만 개발자는 주로 사용X 

5.코드내에서의 컨벤션
5-1. [namespace], [class] , [struct] 는 파스칼을 사용
5-2. [함수]는 파스칼을 사용 , 함수 내부는 카멜을 사용
5-3. [Enum]는 파스칼을 사용
5-4. public 변수는 파스칼을 사용 ex) public int Num;
5-5. 나머지 변수는 _ + 카멜을 사용 ex) private int _num;

 

p.s 추가 정보

(현업에서는 언더바 잘 안씀)

(유니티는 _ 권장함) ::  ( _ 사용시 자동완성 기능 차단)

언더바( _ ) 이유는 클래스 안쪽(뒷쪽)에서 사용하는 거라고 명시하는거라고 합니다.

 

Q. 코드 컨벤션을 요약하면?

A.

1.유니티는 파스칼
2.덩치가 크거나(namespace,class,struct) 이거나 public이면 파스칼
3.non public이면 _ + 카멜
4.함수내부에서 쓰는것 카멜
5.(중요)이름 정할때 누가봐도 알 수 있도록
6. 들여쓰기 잘할것 (영역에 나눠서)
예시)for문 , Ctrl + k -> Ctrl + d 누르면 정렬