반응형
포맷팅이 중요한 이유
- 가독성에 필수적이다.
- 코드를 잘못해석해 버그를 발생할 여지를 줄인다!
클린코드 포맷팅
- 200라인 이하로 유지하자.
- 코드길이가 200라인을 넘어간다면, 클래스가 여러가지 일을 하고 있을 가능성이 높다.
- SRP (클래스 단일 책임 원칙) 위배!
- 밀접한 개념은 서로 가까이 둔다.
- 행 묶음은 완결된 생각 하나를 표현하기 때문에 개념은 빈 행으로 분리
- 변수는 사용되는 위치에서 최대한 가까이 선언한다.
Java Class Declarations
- Class 내부 코드 순서 (static - instance - 생성자 - 메서드)
- static 변수
- public -> protected -> private 순서
- instance 변수
- public -> protected -> private 순서
- 생성자
- 메서드
- public 메서드에서 호출되는 private 메서드는 그 아래 둔다. 가독성 위주의 그룹핑
- static 변수
Team Coding Convention
- 팀 코딩 스타일에 관한 약속
- 개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다.
- ex) 컬럼명 네이밍
본 포스팅은 Clean Code (Robert C. Martin), 제로베이스-한달한권(클린코드)를 참고하여 작성하였습니다.
반응형