less than 1 minute read

1. 포맷팅이 중요한 이유

  • 가독성에 필수적이다.

    코드를 읽기 편하다. 아마추어처럼 보이지 않는다. 코드를 잘못해석해서 버그가 발생할 위험을 줄인다.

2. 클린코드 포맷팅

  • 적절한 길이유지 (200~500라인, 작은 파일이 이해하기 쉽다.)
  • 밀접한 개념은 가까이 (행 묶음은 완결된 생각 하나기 때문에 개념은 빈행으로 분리)

3. Java Class elarations

  • static 변수

    public -> protected -> package -> private

  • instance 변수
  • public -> protected -> package -> private

  • 생성자
  • 메서드

Team coding convention

개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다.

구글 네이밍 문서

JavaDoc

  • java 코드에서 api문서를 html 형식으로 생성해주는 도구
  • 사용방법 /** */ ** 두개로 시작한다다.
  • 필드 level, 메소드 level.
  • 장점 reader mode 에서 설명만 간단히 볼 수 있다.
  • 네이버 가이드

Updated: