[Java] 자바 코드 컨벤션

자바 코드 컨벤션이란?

• 자바 코드 컨벤션은 자바 코드를 작성할 때 일관성을 유지하고 가독성을 높이기 위해 따르는 일련의 규칙이다.
• 규칙은 프로젝트 팀이나 조직에 따라 다르게 적용된다.

---

명명 규칙(Naming Conventions)

• 클래스 이름 : 대문자로 시작하고 명사로 작성. ex) MyClass, Customer
• 메서드 이름 : 소문자로 시작하고 동사로 작성. ex) getData, setAge
• 변수 이름 : 소문자로 시작하며, 여러 단어가 있는 경우 camelCase를 사용. ex) firstName, customerList
• 상수 이름 : 모두 대문자로 작성하며, 단어 간에는 밑줄(_)로 구분. ex) MAX_VALUE, DEFAULT_SIZE

---

 

들여쓰기(Indentation)

• 일반적으로 공백 4개 또는 탭 1개를 사용하여 들여쓴다.

---

중괄호(Braces)

• 중괄호를 사용하여 코드 블록을 작성할 때 일반적으로 K&R 스타일이나 Allman 스타일 중 하나를 선택하여 사용.

- K&R 스타일 : 여는 중괄호가 메서드나 제어 구조와 같은 줄에 있다.

if (condition) {
    // code block
}

- Allman 스타일 : 여는 중괄호가 메서드나 제어 구조와 다른 줄에 있다.

if (condition)
{
    // code block
}

---

주석(Comments)

• 코드를 이해하는 데 필요한 주석을 작성하되, 과도한 주석은 피한다.
• 메서드와 클래스에 대한 설명은 Javadoc 스타일로 작성한다.

---

최대 줄 길이(Maximun Line Length)

• 한 줄의 코드는 최대 80~120자를 넘지 않도록 작성한다.

---

공백(Whitespace)

• 연산자 주변에 공백을 사용하여 가독성을 높인다. ex) a + b, c * d
• 쉼표, 세미콜론 뒤에 공백을 사용. ex) int[] numbers = {1, 2, 3};