Coding Convention

개요

협업과 코드 해석을 위해 FPSWithTower를 제작할 때 사용되는 코딩 규칙을 정리해둔 문서

읽기 쉬운 코드 작성을 목표로 작성됨

함수 및 변수 작성 순서

public - protected - private 순으로 작성

예시

public class SampleClass
{
   public void SamplePublicFunction(){ } 
   public float _publicFloat;

   protected void SampleProtectedFunction(){ }
   protected float _protectedFloat;

   private void SamplePrivateFunction() { }
   private float _privateFloat;
}

함수 및 변수 네이밍 규칙

모든 함수/변수는 파스칼과 카멜방식을 합쳐서 사용한다

-클래스는 대문자부터 작성한다

-함수는 대문자부터 작성한다

-변수는 소문자부터 작성한다

-멤버변수는 _를 붙인다

-메게변수는 붙이지 않는다

예시

-변수/함수이름은 기능을 의미하도록 만든다

반복문을 돌때도 단순히 알파벳이 아닌 의미가 들어가 있도록 작성한다

bool반환함수는 앞에 is/has붙이기

변수의 X, Y는 마지막에 붙이기

var

var사용은 지양하되 아래와 같은 상황에서는 사용이 권장된다.

-객체 생성시에는 뒤에 자료형이 명시됨으로 var사용을 통해 코드를 간결하게 작성

속도 등 기획적인 측면에서 수정 필요하지만 외부클래스에서의 접근 불가능한 변수들은 SerializeField

인터페이스는 앞에 I붙이기 추상클래스는 앞에 A붙이기 열거형은 앞에 E붙이기

접근지정자 명시해주기 private변수의 get set은 _빼고 변수명으로

주석은 줄의 끝이 아닌 별도의 줄에 작성