🧐 JAVA 코드 컨벤션 개론

🙋 코드 컨벤션이 뭐야?

🙋 꼭 해야 됨?

• 1인 개발의 경우는 상관이 없어요 -> 하지만 우리는 보통 협업을 통해 개발을 진행하기 때문에, 남이 짠 코드를 내가 읽어야 할 때나 그 반대의 경우 정해진 컨벤션이 없다면 추가적인 의사소통, 소요 시간의 증가 등 많은 낭비가 발생할 수 있음

한번 직접 봅시다

⚠️ 줄바꿈, 들여쓰기, 중괄호 양식 등 IDE가 자동으로 잘 해주는 부분은 생략

1. 식별자에는 영문/숫자/언더스코어만 허용

변수명, 클래스명, 메서드명 등에는 영어와 숫자만을 사용한다. 상수에는 단어 사이의 구분을 위하여 언더스코어(_)를 사용한다.

// 올바른 예:
// camelCase 적용했다고 가정
public class CodingMinsoo { }
public void doSomethingMethod() { }
int userAge = 25;
String firstName = "Kim";
public static final int MAX_USER_COUNT = 100;
public static final String KINGGOD_URL = "www.google.com"

// 잘못된 예:
public class missileLaunch시스테무 { }  // 한글 사용
int 몇살 = 25; // 한글 사용
String 거어데김씹니꺼 = "Kim";  // 한글 사용
public static final int MaxUserCount = 100;  // 언더스코어 미사용 (PascalCase 사용)
public static final String kingGodUrl = "www.google.com" // 카멜 케이스 사용

2. 한국어 발음대로의 표기 금지

식별자의 이름을 한글 발음을 영어로 옮겨서 표기하지 않는다. 한국어 고유명사는 예외이다.

// 올바른 예
String address = "충청남도 천안시"

// 잘못된 예
String zipzuso = "충청남도 천안시"

3. 패키지 이름은 소문자로 구성

package com.example.board
package com.example.member

4. 클래스/인터페이스 이름에는 파스칼 케이스 적용

5. 클래스 이름에 명사 사용

클래스 이름은 파스칼 케이스를 적용한다, 그리고 명사나 명사절로 짓는다.

public class MemberService {}

public class MemberReport {}

6. 메서드 이름에 카멜케이스 적용