1. 포맷팅이 중요한 이유
- 가독성에 필수적이다.
- 코드를 잘못 해석하는 경우를 방지할 수 있다.
2. 클린코드 포맷팅
- 코드 길이는 200이하를 유지
- 코드 길이가 200라인 넘어간다면, 클래스가 여러개의 일을 하고 있을 수도 있다.
- 현업에서의 대부분의 코드들도 200라인 정도를 유지한다.
- 밀접한 개념은 서로 가까이 둔다.
- 행 묶음은 완결된 생각 하나를 표현하기 때문에 개념은 빈 행으로 분리한다.
- 변수는 사용되는 위치에서 최대한 가까이 선언한다.
3. Java Class Declarations
Class 내부 코드 순서
- static 변수 : public -> protected -> package -> private 순서
- instance 변수 : public -> protected -> package -> private 순서
- 생성자
- 메서드 : public 메서드에서 호출되는 private 메서드는 그 아래에 둔다. 가독성 위주로 그룹핑한다.
4. Team Coding Convention
- 개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다.
- 없다면, 함게 만들어 나간다.
- 예
- MySQL Convention : 컬럼명은 snake_case로 네이밍한다.
- Team Convention : enum 타입으로 사용하는 varvhar 타입의 경우 컬럼명은 _type으로 끝나도록 네이밍한다.
- 참고할만한 컨벤션