본문 바로가기
Dev/Java

Java 컨벤션 요약

by 재영(ReO) 2022. 10. 31.

변수 이름


  • 변수, 클래스, 메서드에 영어랑 숫자만 (언더스코어는 상수만)

  • 한국어 발음대로 적지 않기

  • 패키지 이름은 소문자

  • 클래스, 인터페이스는 단어의 첫글자를 대문자 (카멜표기법)
    ex) AccessToken

  • 클래스는 명사

  • 메소드는 동사 혹은 전치사로 시작

  • 상수는 대문자와 언더스코어

  • 변수는 소문자 카멜표기법
    ex) accessToken



선언


  • 클래스는 소스파일에 한개만(부득이한 경우 내부 클래스로 선언)
  • 클래스 import 할 때는 (*)(와일드카드)없이 모든 클래스 다 쓸 것.
    (static import 에서는 허용.)
  • 한 줄에 한 문장. ;로 끝나면 새 줄로.
  • 하나의 선언문에는 하나의 변수만
  • 배열에서 대괄호는 타입 뒤에 선언
    ex) String[] names;
  • long 타입 값 마지막에는 대문자 L
  • 중괄호 선언은 K&R 스타일로.
  • else, catch, finally, while은 닫는 중괄호와 같은 줄
  • 빈 블럭은 같은 줄에서 중괄호 닫는 것 허용.
  • 조건문, 반복문에 중괄호 필히 사용.


제한자 순서


public protected private abstract static final transient volatile synchronized native strictfp



빈 줄


  • 패키지 선언 후 빈 줄 삽입

  • import는 java, javax, org, ….. 등 정해진 순서로 그룹 묶어서 선언

  • 각 패키지 그룹 사이에 빈줄 삽입

  • 메소드 사이에 빈 줄 삽입



공백


  • 탭이나 공백으로 문장 끝내지 않음
  • 대괄호 뒤에 문장 안 끝나면 공백 삽입
  • 중괄호 시작 전, 종료 후에 공백 삽입.
  • 제어문 키워드와 여는 소괄호 사이에 공백 삽입
    ex) if (…) {
  • 생성자와 메서드의 선언, 호출, 어노테이션 뒤에 쓰는 소괄호와 식별자 사이에는 공백 삽입 안함.
    ex) StringProcessor()
  • 타입캐스팅을 위한 소괄호 내부에는 공백 삽입 안함.
    ex) String message = (String)rawLine;
  • 콤마와 반복문의 구분자에 쓰이는 세미콜론 뒤에는 공백 삽입
    ex) for (int i = 0; i < length; i++)
  • 콜론 앞 뒤에는 공백 삽입
  • 이항,삼항 연산자 앞 뒤에 공백 삽입
    ex) pattern == Access.ABNORMAL
  • 단항 연산자와 연산 대상 사이에는 공백 미삽입
  • 주석문 기호 전후에는 공백 삽입


출처 : https://naver.github.io/hackday-conventions-java/#space-between-keyword-parentheses

캠퍼스 핵데이 Java 코딩 컨벤션naver.github.io