DAY 10

🔖 오늘 읽은 범위 : 5. 형식 맞추기 (96~116p)

---

🤓 책에서 기억하고 싶은 내용

형식을 맞추는 목적

• 돌아가는 코드 vs 형식을 맞춘 코드 오늘 구현한 기능은 다음 버전에서 바뀔 확률은 아주 높다. 오늘 구현한 코드의 구현 스타일과 가독성은 유지보수 용이성과 확장성에 계속 영향을 미친다.
  

적절한 행 길이를 유지하라

• 세로 길이 500줄을 넘지않는 평균 200줄의 파일로도 커다란 시스템을 구축할 수 있다
  

신문 기사처럼 작성하라

• 아주 좋은 신문은 최상단에 기사를 몇마디로 요약하는 표제, 첫 문단은 전체 기사내용을 요약, 내려갈수록 세부사항(날짜,이름,발언,주장) 보여줌

1. 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명
2. 아래로 내려갈수록 의도를 세세하게 묘사
3. 최 하단에 가장 저차원 함수와 세부 내역

개념을 빈 행으로 분리하라

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

  package fitnesse.wikitext.widgets;
  
  import java.util.regex.*;
  
  public class BoldWidget extends ParentWidget {
      public static final String REGEXP = "'''.+?'''";
      private static final Pattern pattern = Pattern.compile("'''(.+?)'''",
          Pattern.MULTILINE + Pattern.DOTALL);
      public BoldWidget(ParentWidget parent, String text) throws Exception {
          super(parent);
          Matcher match = pattern.matcher(text);
          match.find();
          addChildWidgets(match.group(1));
      }
      public String render() throws Exception {
          StringBuffer html = new StringBuffer("<b>");
          html.append(childHtml()).append("</b>");
          return html.toString();
      }
  }

  빈 행은 새로운 개념을 시작한다는 시각적 단서
  

세로 밀집도

• 서로 밀접한 코드의 행은 세로로 가까이 놓여야 한다.

  public class ReporterConfig {
      /**
       * 리포터 리스너의 클래스 이름
       */
      private String m_className;
      /**
       * 리포터 리스너의 속성 */
      private List < Property > m_properties = new ArrayList < Property > ();
      public void addProperty(Property property) {
          m_properties.add(property);
      }
  }

  위 처럼 주석으로 두 인스턴스 변수를 떨어뜨려 놓아서는 안된다.
  

수직 거리

• 서로 밀접한 새념은 세로로 가까이 둬야 한다.
• 두 개념이 서로 다른 파일에 있다면 어쩔수 없으나, 타당한 근거가 없다면 밀접한 개념은 한 파일에 있어야 한다 → protected 변수를 피해야 하는 이유
• 연관성: 한 개념을 이해하는 데 다른 개념이 중요한 정도

변수 선언

• 사용하는 위치에 최대한 가까이 선언
• 함수가 매우 짧은 경우에 지역변수는 함수 맨처음에 선언 해도됌

  private static void readPreferences() {
      InputStream is = null;
      try {
          is = new FileInputStream(getPreferencesFile());
          setPreferences(new Properties(getPreferences()));
          getPreferences().load(is);
      } catch (IOException e) {
          try {
              if (is != null) is.close();
          } catch (IOException e1) {}
      }
  }

• 루프를 제어하는 변수는 루프 문 내부에 선언

  public int countTestCases() {
      int count = 0;
      for (Test each: tests)
          count += each.countTestCases();
      return count;
  }

인스턴스 변수

• 클래스의 맨 처음에 선언
• 변수 간에 세로로 거리를 두지 않음
• 잘 설계한 클래스는 대부분의 메서드가 인스턴스 변수를 사용하기 때문
• C++의 경우 클래스 마지막에 모아놓지만, 잘 알려진 위치에 인스턴스 변수를 모아 놓는다는 사실이 중요

  public class TestSuite implements Test {
      static public Test createTest(Class << ? extends TestCase > theClass,
          ...
      }
      public static Constructor << ? extends TestCase > getTestConstructor(Class << ? extends TestCase > theClass) throws NoSuchMethodException {
          ...
      }
      public static Test warning(final String message) { ...
      }
      private static String exceptionToString(Throwable t) { ...
      }
      private String fName;
      private Vector < Test > fTests = new Vector < Test > (10);
      public TestSuite() {}
      public TestSuite(final Class << ? extends TestCase > theClass) { ...
      }
      public TestSuite(Class << ? extends TestCase > theClass, String name) { ...
          }
          ...............
  }

  → 중간에 인스턴스 변수 숨겨놓으면 찾기 힘들다
  

종속 함수

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

개념적 유사성

• 어떤코드는 개념적인 친화도가 높아서 가까이 배치해야함
• 비슷한 동작을 수행하는 일군의 함수

  public class Assert {
      static public void assertTrue(String message, boolean condition) {
          if (!condition) fail(message);
      }
      static public void assertTrue(boolean condition) {
          assertTrue(null, condition);
      }
      static public void assertFalse(String message, boolean condition) {
          assertTrue(message, !condition);
      }
      static public void assertFalse(boolean condition) {
          assertFalse(null, condition);
      }
      ...
  }

세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지 (고차원 → 저차원)
• 소스에서 첫 함수 몇개만 읽어도 개념을 파악하기 쉬워짐

가로 형식 맞추기

• 최대 120자 정도가 좋다

가로 공백과 밀집도

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

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

  할당(=) 연산자 강조하기 위해 앞뒤에 공백 함수이름과 이어지는 괄호에는 공백 주지 않음 → 밀접함 쉼표를 강조해 인수가 별개라는 사실을 보여줌
  
• 연산자 우선순위 강조위해 공백 사용

  public class Quadratic {
      public static double root1(double a, double b, double c) {
          double determinant = determinant(a, b, c);
          return (-b + Math.sqrt(determinant)) / (2 * a);
      }
      public static double root2(int a, int b, int c) {
          double determinant = determinant(a, b, c);
          return (-b - Math.sqrt(determinant)) / (2 * a);
      }
      private static double determinant(double a, double b, double c) {
          return b * b - 4 * a * c;
      }
  }

  곱셈은 우선순위가 가장 높음 → 승수 사이는 공백 없음 덧셈과 뺄셈은 우선순위 낮음 → 공백
  

가로 정렬

• 아래와 같은 가로 정렬은 오히려 변수병에 집중되게 하는 등의 잘못된 강조 발생

  public class FitNesseExpediter implements ResponseSender
  {
  	private    Socket      socket;
  	protected  long        requestParsingTimeLimit;
  	private    long        requestProgress;
  ...

• 정렬이 필요할 정도로 목록이 길다면 문제는 길이지 정렬 부족이 아니다

들여쓰기

• 범위로 이뤄진 계층을 표현하기 위해 코드를 들여 쓴다
• 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않음
• 클래스 내 메서드는 클래스보다 한 수준 들여 쓴다.
• 메서드 코드는 메서드 선언보다 한 수준 들여 쓴다.
• 블록 코드는 상위 scope 보다 한 수준 더 들여쓴다.

들여쓰기 무시하기

• 짧은 if, while 문에서 들여쓰기 무시하고픈 유혹이 있어도 물리쳐라 잘못된 들여쓰기 무시의 예

  public class CommentWidget extends TextWidget {
  public static final String REGEXP = "^#[^\r\n]*(?:(?:\r\n)|\n|\r)?";
  public CommentWidget(ParentWidget parent, String text){super(parent, text);}
  public String render() throws Exception {return ""; } }

가짜 범위

• 빈 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;
    }
}

🤔 떠오르는 생각

• 아직 100% 와닿지는 않지만 기존에 코드를 작성할때 고민을 하고 망설이던 부분을 확실하게 정해주는 내용이라 좋다

🔎 질문

📝 소감 3줄 요약

• 오늘 구현한 코드의 구현 스타일과 가독성은 유지보수 용이성과 확장성에 평생 영향을 미친다.
• 500줄을 넘지않는 평균 200줄의 파일로도 커다란 시스템을 구축할 수 있다
• 신문 기사처럼 작성하라: 추상화 → 세부적, 유사개념은 가까이