클린코드 (4) 포맷팅

목차

1. 포맷팅이 중요한 이유
2. 클린코드 포맷팅
3. java class declartions
4. Coding Convention

포맷팅이 중요한 이유

public void holliblyFormattedMethod() {
    System.out.println("첫줄");
            System.out.println("두번쨰줄");
          System.out.println("셋째줄");
}

위의 코드는 포맷팅이 제대로 되지 않았다.. 이런코드가 있나 싶다.. 극단적이니깐

public void holliblyFormattedMethod() {
    System.out.println("첫줄");
    System.out.println("둘쨰줄");
    System.out.println("셋째줄");
}

포맷팅 정렬을 해보았다. 훨신 이해하기가 좋다.

포맷팅이 중요한 이유는 이러하다.

• 가독성에 필수적이다 코드를 수월하게 읽어나갈 수 있다. 포맷팅으로 인해 코드를 잘못 해석해 버그 발생 위험이 줄어든다.

자바에서는 이러한 포맷팅에 그나마 유연하지만?. 특정언어에서는 가독성을 떠나 에러와 버그의 문제로 직결된다.

완전 기본중에 기본이다.

클린코드 포맷팅

적절한 길이 유지

• 200라인
  • 코드 길이를 200줄 정도로 제한하는 것
  • 필수는 아니다.
  • 큰파일 보단 작은 파일이 이해하기 쉽다.
  • 코드의 길이가 200라인을 넘어간다면 클래스가 여러개의 일을 할 가능성이 높다. SRP 위배

밀접한 개념은 가까이

• 밀접한 개념은 서로 가까이 둔다.
  • 행 묶음은 완결된 생각 하나를 표현하기 떄문에 개념은 빈 행으로 분리한다.
  • 변수는 사용되는 위체에서 최대한 가까이 선언한다.

Java Class Declarations

Class 내부 코드 순서

1. static 변수
   • public
   • protected
   • package
   • private 순서
2. instance 변수
   • public
   • protected
   • package
   • private
3. 생성자
4. 메서드 public 메서드에서 호출되는 private 메서드는 그 아래에 바로 둔다. 가독성 위주 구룹핑

4. Coding Convention

convention

1 관습, 관례
2 (전문직 종사자들이나 정당 등의 대규모) 대회[협의회] (=conference)
3 (국가나 지도자 간의) 조약[협약]

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

ex)

MySQL Convention (언어적 컨벤션)
컬럼명은 snake_case 로 한다.

Team Convention
enum 타입으로 사용하는 varchar 타입의 경우 컬럼명은 _type으로 끝나도록 네이밍한다.

많이들 보시는 구글 컨밴션 정리