[매일읽기] A short summary of Java coding best practices

원문 : https://medium.com/@rhamedy/a-short-summary-of-java-coding-best-practices-31283d0167d3

A short summary of Java coding best practices

자바 소스 파일

• 한 소스 파일은 2,000 라인을 넘지 않는다.
• 소스 파일은 문서화된 주석과 함께 구성
  1. 패키지 선언
  2. 클래스에 관한 주석
  3. import 부분 (static은 마지막에)
  4. 클래스/인터페이스 부분

네이밍

• 클래스와 인터페이스는 카멜 케이스
  • 두문 문자와 같은 줄임말(ex. CEO) 외에 모든 단어에 적용
• 패키지는 도메인 레이블 단위 내에서는 소문자와 붙여쓰기로 작성
  • com.hello_world (x)
  • com.helloWorld (x)
  • com.helloworld
• 파일 이름은 카멜 케이스로 작성하고 클래스 이름과 같도록 작성
  • 소스 파일 내부에는 최상위 레벨이자 하나의 public 클래스가 존재
• 메서드는 동사로 작성하고 단어 간 구분은 대문자로 구분
• 상수는 대문자로 작성하며 '_'로 단어 간 구분
• 변수는 코드의 독자가 분명하게 무엇인지 알 수 있도록 간결하게 작성

기타

• 들여쓰기는 2 혹은 4 스페이스나 탭을 이용
  • 꼭 일관되게 구성
• 한 줄의 길이는 70~120자 사이
• switch 문
  • 항상 default 케이스 포함
  • break 걸리지 않은 케이스는 주석으로 표시
• 예외 메시지는 적절한 들여쓰기와 줄 바꿈 사용
• 선언과 할당
  • 변수 선언은 코드 블럭 시작 부분에
• 와일드카드 임포트는 피한다.
• 오버 라이딩할 때는 항상 @Override 어노테이션을 붙인다.
• null 반환이 가능할 경우 @Nullable 어노테이션을 붙인다.

문서화와 주석

• 주석은 코드 자체에서 보이지 않는 정보를 추가적으로 제공하거나 전체적인 코드의 의미(혹은 목적)를 전달하기 위해 작성
• 주석의 종류
  • 블록 주석 : 블록 형태로 구성된 주석 뭉치 (/** ... */)
  • 한 줄 주석
  • 뻗는(Trailing) 주석 : 코드 우측 끝에 붙는 주석
  • 마지막 줄 주석
• 문서화 주석은 javadoc 스타일에 맞춰 작성
• 주석은 개인적인 내용 혹은 어투로 작성하지 않는다.

읽고나서

• 여러 글로벌 IT 기업의 스타일 가이드를 축약한 문서라 쉽고 간편하게 읽음
• 변수 선언을 사용하는 곳 근처에 하는 버릇이 있었는데, 앞으로 스코프를 잘 나누고 블록 앞단에 해야겠음