[Clean Code] 형식 맞추기

형식을 맞추는 목적

코드 형식은 의사소통의 일환이다. 그러므로 원활한 소통을 하기 위해서는 코드 형식이 매우 중요하다.

코드 형식이 중요한 이유

• 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다.
• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
• 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

코드 길이를 200줄 정도로 제한하는 것은 반드시 지킬 엄격한 규칙은 아니지만,
일반적으로 큰 파일보다는 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

• 소스 파일 이름은 간단하면서도 설명이 가능하게 짓자.
• 이름만 보고도 올바른 모듈을 살펴보고 있는지를 판단할 수 있어야 한다.
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 아래로 내려갈수록 의도를 세세하게 묘사한다.
• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

• 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이는 빈 행을 넣어 분리해야 한다.

세로 밀집도

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

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
• 변수 선언
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수
  • 클래스 맨 처음에 선언한다.
  • 변수 간에 세로로 거리를 두지 않는다.
• 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 호출하는 함수를 호출되는 함수모다 먼저 배치한다.
• 개념적 유사성
  • 개념적인 친화도가 높으면 서로 가까이 배치한다.
  • 예) 직접적인 종속성, 변수와 그 변수를 사용하는 함수, 비슷한 동작을 수행하는 함수들
• 세로 순서
  • 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.

가로 형식 맞추기

120자 정도로 길이를 제한한다.

가로 공백과 밀집도

• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

가로 정렬

• 별로 유용하지 못하다.
• 선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

• 들여쓰기한 파일은 구조가 한눈에 들어온다.
• 간단한 if 문, 짧은 while 문, 짧은 함수에서도 들여쓰기를 사용하자.

가짜 범위

• 빈 while 문이나 for 문을 피하지 못할 때는 세미콜론을 새 행에다 제대로 들여써서 넣어주자.

  while (dis.read(buf, 0, readBufferSize) != -1)
  ;

팀 규칙

팀에 속한다면 팀 규칙을 따라야 한다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄지고, 읽기 쉬운 문서는 스타일이 일관적이고 매끄러워야 한다.

밥 아저씨의 형식 규칙

아래는 코드 자체가 최고의 구현 표준 문서가 되는 예이다.

public class CodeAnalyzer implements JavaFileAnalysis { 
    private int lineCount;
    private int maxLineWidth;
    private int widestLineNumber;
    private LineWidthHistogram lineWidthHistogram; 
    private int totalChars;

    public CodeAnalyzer() {
        lineWidthHistogram = new LineWidthHistogram();
    }

    public static List<File> findJavaFiles(File parentDirectory) { 
        List<File> files = new ArrayList<File>(); 
        findJavaFiles(parentDirectory, files);
        return files;
    }

    private static void findJavaFiles(File parentDirectory, List<File> files) {
        for (File file : parentDirectory.listFiles()) {
            if (file.getName().endsWith(".java")) 
                files.add(file);
            else if (file.isDirectory()) 
                findJavaFiles(file, files);
        } 
    }

    public void analyzeFile(File javaFile) throws Exception { 
        BufferedReader br = new BufferedReader(new FileReader(javaFile)); 
        String line;
        while ((line = br.readLine()) != null)
            measureLine(line); 
    }

    private void measureLine(String line) { 
        lineCount++;
        int lineSize = line.length();
        totalChars += lineSize; 
        lineWidthHistogram.addLine(lineSize, lineCount);
        recordWidestLine(lineSize);
    }

    private void recordWidestLine(int lineSize) { 
        if (lineSize > maxLineWidth) {
            maxLineWidth = lineSize;
            widestLineNumber = lineCount; 
        }
    }

    public int getLineCount() { 
        return lineCount;
    }

    public int getMaxLineWidth() { 
        return maxLineWidth;
    }

    public int getWidestLineNumber() { 
        return widestLineNumber;
    }

    public LineWidthHistogram getLineWidthHistogram() {
        return lineWidthHistogram;
    }

    public double getMeanLineWidth() { 
        return (double)totalChars/lineCount;
    }

    public int getMedianLineWidth() {
        Integer[] sortedWidths = getSortedWidths(); 
        int cumulativeLineCount = 0;
        for (int width : sortedWidths) {
            cumulativeLineCount += lineCountForWidth(width); 
            if (cumulativeLineCount > lineCount/2)
                return width;
        }
        throw new Error("Cannot get here"); 
    }

    private int lineCountForWidth(int width) {
        return lineWidthHistogram.getLinesforWidth(width).size();
    }

    private Integer[] getSortedWidths() {
        Set<Integer> widths = lineWidthHistogram.getWidths(); 
        Integer[] sortedWidths = (widths.toArray(new Integer[0])); 
        Arrays.sort(sortedWidths);
        return sortedWidths;
    } 
}