공부일지
코드 컨벤션 본문
<aside> 💡 대표적인 코딩 컨벤션
- 검색 가능한 이름을 사용하라
- 함수명은 동사로 지어라
- 함수의 파라미터는 3개 이하가 적당하다
- 함수의 파라미터로 boolean타입을 사용하지 마라
- 변수명을 너무 축약하지 마라
- 함수는 하나의 역할을 하는 것이 좋다. </aside>
💡 대표적인 코딩 컨벤션
1. 검색 가능한 이름을 사용하라
2. 함수명은 동사로 지어라
3. 함수의 파라미터는 3개 이하가 적당하다
4. 함수의 파라미터로 boolean타입을 사용하지 마라
5. 변수명을 너무 축약하지 마라
6. 함수는 하나의 역할을 하는 것이 좋다.
💡
삼항 연산자를 쓸 수 있으면 if-else대신 쓴다
중괄호 없는 한 줄짜리 블록을 쓰지 않는다 ex) if문
Switch문을 쓸 수 있으면 사용하는것을 권장
문자열 포멧팅은 string interpolation을 권장
$"A: {a} / B: {b} 1+2 = {1+2}“
클래스 이름, public 메소드, 프로퍼티는 PascalCase로
로컬변수 및 매개변수는 camelCase
Private 함수는 _camelCase로
메소드, 필드, 프로퍼티 프라이빗, 퍼블릭끼리 모아둘것
자주 사용될것 같은 메소드에 XML태그 주석 붙이기
유니티 폴더명
코드 컨벤션이나 규칙 등 정하기
한줄 짜리 반복문, 조건문 등에서도 중괄호
공백
ex) for (int i = 0; i < 100; i++)
**#1 코드컨벤션**
**1. 지역 변수 소문자 시작 (camelCase) / ex. int camelCase = 0;
2. 변수 받아오기 (인자값 등 ) (camelCase) / ex. '_' + 소문자시작 / void Test(int _camelCase){ ... }
3. 메서드는 Pascal Case -> void TestCase(){}
ex.메서드 작성 예시
public void UpdateStats()
{
... method Contents
}
4. 이벤트(버튼클릭 , fire등등) 처리함수 -> On 으로 함수명 시작 / ex. OnFire(), OnClick~~~Btn()
5. enum 이름,내용 (Pascal Case) ->
/ ex.
enum TestEnum
{
TESTCASE1,
TESTCASE2, (x)
TestCase3 (o)
}
-----------------------------------------------------------------------------------------
#2 머지 진행방식
0. Main씬 복사해서 각자 이름의 씬으로 작업하기 <> Branch 만들고 MainScene 복사 > KJH_Scene
0-1. 개인 스프라이트나 스크립트등 담을 폴더는 개인 이니셜 (KJH) 로 하나 만든 후 안에다가 넣기.
0-2. [Resources같이 변경 불가한 폴더](<https://shhouse.tistory.com/11>)**는, 생성후 팀원한테 알려주기
**1. Main으로 올리기 전 단계 브랜치인 Beta 브랜치 만들기
2. 각자 작업한 것을 기능별로 브랜치 만들어서 커밋 하기
3. 6시 이후에 Beta로 PullRequest 를 한 후, 같이 머지 작업 진행하기
4. 3번이 끝난 후 Main으로 Beta브랜치 머지하기
5. Push 하기 전에 Beta Fetch - Pull 먼저 하기!**
Reference
C# 코드 스타일 가이드 만들기 | Unity Blog
[Unity] Coding guidelines & Basic Best Practices - Avangarde-Software
'코딩 > Unity' 카테고리의 다른 글
스크립터블 오브젝트 (0) | 2023.10.30 |
---|---|
Delegate(대리자) - 작성중 (1) | 2023.10.26 |
유한 상태 머신 (finite-state machine) - 작성중 (3) | 2023.10.07 |
싱글톤의 변형과 제네릭 개념 (1) | 2023.09.27 |
MonoBehaviour 추가 강의[09.21] (1) (1) | 2023.09.21 |