[개발 팁] 네이밍규칙

. 최초작성 : 2017. 03. 15.

. 최종수정 : 2017. 03. 16.

. 작성/수정내용 :

  - 프로그램 네이밍 규칙

---

오래간만에 소스를 분석 하려니

개발에 대한 기준도 없고, 네이밍 룰 조차 명확하지 않은

뒤죽박죽인 프로젝트를 보면서

세삼 프로그램 네이밍 규칙의 필요성을 느끼고 있습니다.

그래서 한 번 정리해 보았습니다.

프로그램 네이밍 규칙

1. 클래스나 메소드명은 파스칼 표기법을 따른다.

  모든 단어에서 첫 번째 문자가 대문자이며 나머지는 소문자로 표기.

  public class HelloWorld{            // 클래스명

    public void HelloCity(){           // 메소드명

    }

  }

2. 변수, 파라미터 등은 카멜 표기법을 따른다.

  최초에 사용된 단어를 제외한 모든 단어의 첫 문자가 대문자이며, 나머지는 소문자로 표기.

  int totalCost = 0;               // 변수명

  String fullName = "";

  

  public void HelloCity(String familyName){};          // 파라미터명

  

3. 변수에 모든 의미를 충분히 담을것 (접두사 제외)

  가능하면 모든 축약어를 사용하지 않고, 의미를 바로 알 수 있도록 합니다.

  위의 변수명 중에서 totalCost 같은 경우,

  total 을 tot 라고 축약어를 사용하는 경우도 많이 있습니다.

  

  하지만 예외의 경우도 있습니다.

  접두사를 사용하여 변수명을 지을때 접두사는 축약어를 사용하는 편이 좋습니다.

  

의미	접두어	사용예
Label	lbl	lblText
Button	btn	btnSave
Image	img	imgTitle
Table	tbl	tblStudent
Dataset	ds	dsBook
Grid	grd	grdList
Combo	cb	cbCodebook

4. "a, i, j" 같이 하나의 문자로 된 이름은 사용자지 말것 (반복문 제외)

5. 네임스페이스(패키지명 등)은 회사 표준 패턴에 따라 사용

  네임스페이스 작명은 다른 라이브러리를 import 할 때 사용하는 것을 참고 하면 많은 도움이 될거 같습니다.

  자바를 예를 들어 보면 아래와 같죠.

  ex) <com/org>.<회사명>.<제품명/프로젝트명>.<최상위모듈>.<하위모듈>

    org.apache.common.lang.StringUtils;

6. 키워드와 비슷한 이름은 쓰지 말것. (단, 다른 단어와 조합하여 사용은 제외)

  프로그램에서 키워드라고 하는 것은 보통 static, public 같은 예약어들입니다.

  물론 단독으로 쓰면 컴파일시 에러를 발생하던가 하겠지요.

  하지만 가능하면 피하는 것이 좋고, 의미 부여를 위해 어쩔 수 없다면 

  다른 단어 적절한 조합을 이루어 사용하는 것이 좋습니다.

7. Boolean 변수에는 is 접두어를 사용.

 isFind, isExist