[클린 코드] 형식 맞추기

• 코드의 형식을 맞추기 위한 규칙을 정하고 착실히 따라야 한다

형식을 맞추는 목적

• 오늘 구현한 기능이 다음 버전에서 바뀔 확률이 높다
  • 오늘 구현한 코드의 가독성을 앞으로 바뀔 코드에 영향
• 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 영향

적절한 행 길이 유지

• 소스코드는 얼마나 길어야 적당할까?
  • 대부분 200줄 이상으로도 커다란 시스템을 구축할 수 있다.
• 큰 파일보다 작은 파일이 이해하기 쉽다!
  • 너무 당연하다..

신문 기사처럼 작성하라

• 기사 최상단에는 내용을 요약하는 표제가 존재
  • 소스코드도 비슷하게 작성한다.
• 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 보고 있는지 알 정도로 신경 써야 한다
• 코드 구성
  • 첫 부분: 고차원 개념 & 알고리즘 설명
  • 아래로 내려갈수록 의도를 세세하게 묘사
  • 마지막: 가장 저차원 함수와 세부 내역

개념은 빈 행으로 분리하라

• 거의 모든 코드는 왼쪽 → 오른쪽, 위 → 아래로 읽힌다.
• 빈 행은 새로운 개념을 시작한다는 시각적 단서
• 메서드 사이는 빈 행을 넣어 분리한다.

세로 밀집도

• 줄바꿈은 개념을 분리
• 세로 밀집도는 연관성을 의미
  • 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

    public class ReporterConfig {
      
        private String m_className;
      
        private List<Property> m_properties = new ArrayList<Property>();
        public void addProperty(Property property) {
            m_properties.add(property);
    }
  

  • 위에 것보다는 아래 것이 더 보기 좋다

    public class ReporterConfig {
      
        private String m_className;
        private List<Property> m_properties = new ArrayList<Property>();
      
        public void addProperty(Property property) {
            m_properties.add(property);
    }
  

수직 거리

• 서로 밀접한 개념은 세로로 가까이 두어야 한다
  • 두 개념이 서로 다른 파일에 속하면 규칙이 통하지 않음
• 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 한다.
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현
• 연관성이 깊은 두 개념이 멀리 떨어져 있음 → 여기저기 뒤져야 한다

변수

• 사용하는 위치에서 최대한 가까이 선언
• 루프문 제어 변수는 루프문 내부에 선언한다.

인스턴스변수

• 클래스 맨 처음에 선언
• 변수 간 세로 거리 x
• 잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용한다.

종속 함수

• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치
• 호출하는 함수를 호출되는 함수보다 먼저 배치

개념적 유사성

• 개념적인 친화도가 높을 수록 가까이 배치
• 친화도가 높은 요인
  1. 종속성: 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
  2. 변수와 그 변수를 사용하는 함수
  3. 비슷한 동작을 수행하는 함수

세로 순서

• 함수 종속성은 아래 방향으로 유지
• 호출되는 함수를 호출하는 함수보다 나중에 배치
  • 소스 코드 모듈이 고차운 → 저차원으로 자연스럽게 내려간다

가로 형식 맞추기

• 한 행은 가로로 얼마나 길어야 적당할까?
  • 80자 이후는 거의 없음
  • 짧은 게 최고
• 100~120까지도 괜찮다 → 그 이상은 안된다.

가로 공백과 밀집도

• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념 표현
• int lineSize = line.length()
  • 할당 연산자 강조 → 앞 뒤로 공백 존재
  • 왼쪽 요소와 오른쪽 요소가 확실히 나뉜다.
• lineWidthHistogram**.**addLine**(**lineSize**,** lineCount**);**
  • 함수 이름과 이어지는 괄호에는 공백 x
    • 함수와 인수는 서로 밀접한 관계이기 때문

들여쓰기

• 소스 파일은 윤곽도와 계층이 비슷
  • 파일 전체에 적용되는 정보
  • 파일 내 개별 클래스에 적용되는 정보
  • 클래스 내 각 메서드에 적용되는 정보
  • 믈록 내 블록에 재귀적으로 적용되는 정보

  → 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위

• 이렇게 범위로 이루어진 계층 표현을 위해 들여쓰기가 필요하다!
  • 들여쓰는 정도 = 계층에서 코드가 자리잡은 수준에 비례
  • 클래스 정의 = 파일 수준의 문장 → 들여쓰기 X
  • 클래스 내의 메서드 = 클래스보다 한 수준 들여쓰기
  • 메서드 내의 코드 → 메서드 선언보다 한 수준 들여쓰기
• 들여쓰기한 파일은 구조가 한눈에 들어온다.

들여쓰기 무시하기

• 간단한 if문, 짧은 while문, 짧은 함수에서 들여쓰기 규칙 무시 → 안된니까 착실하게 들여써라

가짜 범위

• 때로는 빈 while문이나 for문 존재
  • 가능한 피한다.
• 만약에 만약에 쓰게 되면 세미콜론을 새 행에 제대로 들여써서 넣어주어야 한다

팀 규칙

• 팀은 한 가지 규칙에 합의해야 한다.
  • 규칙을 따라야 함
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어 진다.
  • 스타일은 일관적이고 매끄러워야 함
  • 한 소스 파일에서 봤던 형식이 다른 파일에도 쓰여야 한다. -