프로젝트 시, 각종 명명 규칙

코딩을 할 때, 항상 우리가 고민하는게 있다. 바로 네이밍 규칙이다.

N 모 회사에 다니는 친구 말로는 이 네이밍 하나 때문에 몇시간을 회의한적이 있다할 정도로 프로젝트시 네이밍 규칙을 정하는 건 중요하다.

 

완성된 프로젝트만 봐도 네이밍 규칙이 지켜지지 않은 프로젝트는 보통은 프로젝트 전체가 엉망인 경우도 많이 봤다. 

네이밍 규칙은 보통은 회사내부에 정해진 규칙을 따르면 되지만, 간혹 가다가 혼자서 결정해야하는 경우도 발생한다.

 

이럴 경우 아래의 방식을 따라보기를 권한다.( 나는 주로 자바를 개발해왔기에 자바 기반의 네이밍이다...)

 

1. Pascal Case

모든 단어에서 첫번째 문자가 대문자이고, 나머지는 소문자인 표기법을 의미한다.

쌍봉낙타를 닮아서 쌍봉낙타 표기법이라고도 부르고 영어로는 UpperCamelCase 라고도 부른다.

 

자바에서는 보통 클래스명을 Pascal Case로 활용해서 지으면 된다.

public class UserRepository {
	...
}

 

2. (Lower) Camel Case

보통 Camel Case라고 하면 Lower Camel Case를 의미한다

처음 나온 단어는 소문자로 시작하고, 그 이외의 단어는 첫문자가 대문자이며, 나머지는 소문자로 표기하는 방법이다.

단봉 낙타 표기법이라고 부르기도 한다.

String userName;

public void updateName(String userName) {
	...
}

 

3. UpperCase

모든 글자를 대문자로 하는 것을 의미하며, 단어의 구분은 _ 로 한다.

보통 상수에 사용된다.

public static final String IP_ADDRESS = "127.0.0.1";
public static final String PORT = "8080";

 

4. Hungarian notation (헝가리언 표기법)

사용하고자 하는 변수 앞에, 변의 타입이나 기능의 축약어를 접두어로 붙이는 방법을 의미한다.

 

타입은 ch-char, db-dobuble, str- string, b -boolean 등이 있고,

기능은 lbl- Label, btn - Button, img - Image, tbl - Table, ds - Dataset, grd - Grid, cb-Combo 등이 있다.

 

그리고 멤버 변수와 로컬 변수를 구분하기 위해 멤버 변수에 m 을 붙이는것도 헝가리언 표기법이라 할수 있겠다.

private Button btnSave;
private String mUserName;

public String parseData(String strJsonData) {
	...
}

 

* 그외 꿀팁

- 변수를 만들때는 변수의 의미를 충분히 담아야 한다.

- a,i,j 같이 단일 문자는 변수로 사용하지 않아야한다 . ( 반복문에서는 사용)

- boolean 변수는 보통 is 접두어를 사용한다.

- 가장 중요한건  일하고 있는 회사의 표준을 지키는 것이다.

 

끝.