[Java] 네이밍 규칙

👀 공통 네이밍 규칙

1. 대소문자가 구분되어야 하고, 길이에 제한이 없다.

2. 예약어는 사용하지 않는다.

3. 숫자로 시작하면 안 된다.

4. 특수문자는 '_' (언더바)와 '$'만 허용한다.

5. 파스칼 표기법(PascalCase)과 카멜 표기법(camelCase)을 사용한다.

• PascalCase: 모든 단어에서 첫 번째 문자는 대문자이며 나머지는 소문자이다.
• camelCase: 최조에 사용된 단어를 제외한 첫 번째 문자가 대문자이며 나머지는 소문자이다.

6. 반의어는 반드시 대응하는 개념으로 사용해야 한다.

 

주로 쓰는 반의어
get / set add / remove create / destroy start / stop insert delete increment / decrement old / new begin / end girst / last up / down min / max next / previous open /close show /hide suspend /resume parent / child	받다/ 받다 추가/제거 창조/파괴하다 시동/정지 삽입/삭제 증가/감소 구/신 시작/끝 긴/마지막 위/아래 최소/최대 다음/이전 열다/ 닫다 보이다/ 숨기다 일시 정지/재개하다 부모/아이

 

1️⃣ 패키지 이름 짓기

- 패키지명은 표준 패턴을 따라야 한다.

• Ex) [com].[Company].[Project].[TopPackage].[LowerPackage]

- 모두 소문자 사용을 권장한다.

- 가급적 한 단어 사용을 권장한다.

 

2️⃣ 클래스 이름 짓기

- 클래스명은 명사로 한다.

- 클래스명은 대문자로 시작한다.

- 여러 개의 단어를 조합하여 만들 경우 각 단어의 첫 번째 글자는 대문자이어야 한다. (파스칼 케이스)

class Cookie {}
class ChocoCookie {}

 

3️⃣ 메서드 이름 짓기

- 메서드명은 동사로 한다.

- 메서드명은 소문자로 시작한다.

- 여러 개의 단어를 조합하여 만들 경우 맨 첫 글자를 제외한 나머지 단어의 첫 글자는 대문자를 쓴다. (카멜 케이스)

run();
runFast();
getBackground();

 

4️⃣ 변수 이름 짓기

- 변수 이름은 짧지만 의미가 있어야 한다. 즉, 변수명만 봐도 사용한 이유를 알 수 있도록 지어야 한다.

- 순서를 의미하고 임시로 쓰이는 정수의 변수명은 i, j, k, m, n을 사용한다. (문자의 경우는 c, d, e 등을 사용)

- 변수명에 _, $를 쓸 수 있지만 시작 문자로 사용하는 것은 지양한다.

String userName;
float lineWidth;
int i;  // 주로 반복문에서 사용
char c;  // 주로 반복문에서 사용

 

 

 

참고 링크

https://wikidocs.net/1936

https://thalals.tistory.com/325