자바 코드 컨벤션

핫다리·2023년 3월 20일

CS

목록 보기
46/46

자바 코드를 작성할 때 일관성을 유지하고 가독성을 높이기 위해 따르는 일련의 규칙

명명 규칙

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

들여쓰기

공백 4개 또는 탭 1개를 사용하여 들여쓰기를

중괄호

  • K&R 스타일이나 Allman 스타일 중 하나를 선택하여 사용

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

if (condition) {
    // code
}

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

if (condition)
{
    // code
}

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

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

공백
연산자 주변에 공백을 사용하여 가독성을 높임. 예: a + b, c * d.

쉼표, 세미콜론 뒤에 공백을 사용.

profile
일단 만들고 본다

0개의 댓글