[클린코드] 5장 형식 맞추기

형식을 맞추는 목적

• 지금 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다.
• 지금 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
• 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

 

적절한 행 길이를 유지하라

• 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
• 여러 프로젝트를 조사해 보면 평균 파일 크기는 약 65줄이다.

 

신문 기사처럼 작성하라

• 첫 문단은 전체 기사 내용을 요약한다.
• 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.
• 소스 파일 이름은 간단하면서도 설명이 가능하게 짓는다.
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

 

개념은 빈 행으로 분리하라

package subway.service;

import subway.domain.Station;
import subway.repository.StationRepository;
import subway.view.OutputView;

public class StationService {
    private static final OutputView outputView = new OutputView();

    public void registerStation(Station station) {
        StationRepository.addStation(station);
    }

    public void deleteStation(Station station) {
        StationRepository.deleteStation(station);
    }

    public void viewStation() {
        outputView.printStations(StationRepository.stations());
    }
}

위 코드는 패키지 선언부, import문, 각 함수 사이에 빈 행이 들어간다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

 

package subway.service;
import subway.domain.Station;
import subway.repository.StationRepository;
import subway.view.OutputView;
public class StationService {
    private static final OutputView outputView = new OutputView();
    public void registerStation(Station station) {
        StationRepository.addStation(station);}
    public void deleteStation(Station station) {
        StationRepository.deleteStation(station);}
    public void viewStation() {
        outputView.printStations(StationRepository.stations());}}

하지만 위 코드처럼 빈 행을 빼버리면 코드 가독성이 현저하게 떨어진다.

때문에 개념 사이는 빈 행을 넣어 분리해야 한다.

 

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
• 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 한다.
• 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 뒤져야 한다.

 

변수 선언

• 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 함수는 짧게 만들 것이므로 지역 변수는 각 함수 맨 처음에 선언한다.

 

인스턴스 변수

• 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 변수 간에 세로로 거리를 두지 않는다.

 

종속 함수

• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
• 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
• 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.

 

개념적 유사성

• 개념적인 친화도가 높은 코드는 서로 끌어당긴다. 친화도가 높을수록 코드를 가까이 배치한다.
• 친화도가 높은 요인으로는 직접적인 종속성, 비슷한 동작을 수행하는 일군의 함수 등이 있다.

 

들여 쓰기

• 범위로 이뤄진 계층을 표현하기 위해 코드를 들여 써야 한다.
• 들여 쓰는 정보는 코드가 계층에서 자리 잡은 수준에 비례한다.

 

팀 규칙

• 본인이 팀에 속해있다면 선호해야 할 규칙은 팀 규칙이다.
• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.