형식 맞추기 (code format)

여럿이 팀으로 작업하는 환경에서 상호 합의한 규칙과 정해진 양식을 맞추는 것은 코드에 대해 소통하는데 용이하도록 하는 기본 요건이라 생각합니다.

• 알아보기 쉬운 코드를 작성해야 합니다. 그리고 습관이 되어야 합니다.
• 코드 형식을 맞추기 위한 (간략) 규칙을 정하고 그 규칙을 착실하게 따라야 합니다.
• 코드 형식을 자동으로 맞춰주는 기능을 적극적으로 활용하면 편리합니다. (ctrl + alt + L)

형식을 맞추는 목적

• 코드 형식은 의사소통의 일환이다. → 의사소통은 전문 개발자의 일차적인 의무다.
• 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
• 코드는 계속 변화하지만 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
  • 개발자의 스타일과 규율은 사라지지 않는다.

적절한 길이의 코드 작성

신문 기사처럼 작성하라

• 신문 기사
  • 독자는 위에서 아래로 기사를 읽는다
  • 최상단에 기사를 몇 마디로 요약하는 표제가 나온다
  • 첫 문단은 전체 기사 내용을 요약한다 (큰 그림을 보여줌)
  • 날짜, 이름, 발언, 주장, 기타 세부사항이 나온다.
• 소스 파일도 신문 기사와 비슷하게 작성한다.
  • 이름은 간단하면서도 설명이 가능하게 짓는다.
    • 이름만 보고 올바른 모듈을 살펴보고 있는지 판단할 정도로 신경 써서 짓는다.
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다
  • 아래로 내려갈수록 의도를 세세하게 묘사한다.
  • 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

• 거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽힌다.

• 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.

• 생각 사이는 빈 행을 넣어 분리해야 마땅하다. (개념의 분리)

• 빈행 사용의 예

  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(l));
      }
  
      public String render() throws Exception {
          StringBuffer html = new StringBuffer("<b>");
          html.append(childHtml()).append("</b>");
          return html.toString();
      }
  }

  • 패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다.

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

  • 빈 행이 빠진다면 코드 가독성이 현저하게 떨어져 암호처럼 보인다.

    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(l));
        }
        public String render() throws Exception {
            StringBuffer html = new StringBuffer("<b>");
            html.append(childHtml()).append("</b>");
            return html.toString();
        }
    }

수직 거리

• 시스템이 무엇을 하는지 이해하고 싶은데, 조각을 찾아 다니고 기억하느라 시간과 노력이 소모된다.
• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
  • 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
  • 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
• 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
  • 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수 선언

• 변수는 사용하는 위치에 최대한 가까이 선언한다.

• 지역 변수는 각 함수 맨 처음에 선언한다.

  private static void readPreferences() {
      try (InputStream is = new FileInputStream(getPreferencesFile());) {
          setPreferences(new Properties(getPerferences()));
          getPreferences().load(is);
      } catch (IOException e) {
          e.printStackTrace();
      }
  }

• 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

  	```java

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

인스턴스 변수

• 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 변수 간에 세로로 거리를 두지 않는다.
• 잘 설계한 클래스는 많은 (혹은 대다수) 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
• 인스턴스 변수를 선언하는 위치는 논쟁이 분분하다.
  • C++ 에서는 모든 인스턴스 변수를 클래스 마지막에 선언한다. (scissors rule 적용)
  • Java 에서는 클래스 맨 처음에 인스턴스 변수를 선언한다.
  • 중요한 것은 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요. (통용되는 위치)

종속 함수

• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

• 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

• 규칙을 일관적으로 적용한다면 호출되는 함수를 찾기 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.

• 함수 배치의 예

  public class WikiPageResponder implements SecureResponder {
      protected WikiPage page;
      protected PageData pageData;
      protected String pageTitle;
      protected Request request;
      protected PageCrawler crawler;
  
      public Response makeResponse(FitNesseContext context, Request request) throws Exception {
          String pageName = getPageNameOrDefault(request, "FrontPage");
          loadPage(pageName, context);
          if (page == null)
              return notFoundResponse(context, request);
          else
              return makePageResonse(context);
      }
  
      private String getPageNameOrDefault(Request request, String defaultPageName) {
          String pageName = request.getResource();
          if (StringUtil.isBlank(pageName))
              pageName = defaultPageName;
  
          return pageName;
      }
  
      private void loadPage(String resource, FitNesseContext context) throws Exception {
          WikiPagePath path = PathParser.parse(resource);
          crawler = context.root.getPageCrawler();
          crawler.setDeadEndStrategy(new VirtualEnabledPageCrawler());
          page = crawler.getPage(context.root, path);
          if (page != null) {
              pageData = page.getData();
          }
      }
  
      private Response notFoundResponse(FitNesseContext context, Request request) throws Exception {
          return new NotFoundResponder().makeResponse(context, request);
      }
  
      private Response makePageResonse(FitNesseContext context) throws Exception {
          pageTitle = PathParser.render(crawler.getFullPath(page));
          String html = makeHtml(context);
  
          SimpleResponse response = new SimpleResponse();
          response.setMaxAge(0);
          response.setContext(html);
  
          return response;
      }
  ...
  }

  • 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.

    • 함수 안에 상수를 사용하는 방법도 있지만 기대와는 달리 잘 알려진 상수가 적절하지 않은 저차원 함수에 묻힌다.

      String pageName = getPageNameOrDefault(request, "FrontPage");
      ...
      private String getPageNameOrDefault(Request request, String defaultPageName) {
          String pageName = request.getResource();
          if (StringUtil.isBlank(pageName))
              pageName = defaultPageName;
      
          return pageName;
      }

      상수를 선언할 때 가급적 사용하는 함수 안에 선언하는 것보다는 선언한 뒤에 전달하는 방식이 권장되는 것 같습니다. 나중에 상수 값이 바뀌어야 할 때 param으로 선언한 함수는 전달 값만 바꾸면 되기 때문에 좀 더 편하게 관리할 수 있는 것 같습니다.

개념적 유사성

• 개념적인 친화도가 높을수록 코드를 가까이 배치한다.

• 친화도가 높은 요인

  • 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성

  • 변수와 그 변수를 사용하는 함수

  • 비슷한 동작을 수행하는 일군의 함수

    // Junit 4.3.1
    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(double a, double b, double 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;
      }
  }

  • 승수 사이는 공백이 없다. → 곱셈은 우선순위가 가장 높기 때문
  • 항 사이에는 공백이 들어간다. → 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문
  • 불행히도... 코드 형식을 자동으로 맞춰주는 도구는 대다수가 연산자 우선순위를 고려하지 못하므로 수식에 똑같은 간격을 적용한다. (도구에서 없애는 경우가 흔하다.)

책의 내용 그대로를 준수하고 싶지만 실제로 전부 외우지를 못하기 때문에 IDE 자동정렬을 자주 사용하는 편입니다. 팀에서 사용하는 규칙이 정렬과 다르다면 최대한 환경설정을 수정하는 식으로 사용합니다.

가로 정렬

• 선언문과 할당문의 정렬은 코드가 엉뚱한 부분을 강조해 진짜 의도를 가려버린다.
  • 코드 형식을 자동으로 맞춰주는 도구는 대다수가 정렬을 무시한다.
• 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
  • 선언부가 길다면 클래스를 쪼개야 한다는 의미이다.

들여쓰기

• 소스 파일은 윤곽도(outline)와 계층이 비슷하다.
  • 파일 전체에 적용되는 정보가 있고
  • 파일 내 개별 클래스에 적용되는 정보가 있고
  • 클래스 내 각 메서드에 적용되는 정보가 있고
  • 블록 내 블록에 재귀적으로 적용되는 정보가 있다.
• 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.
• 범위(scope)로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
  • class 내 method는 class보다 한 수준 들여쓴다.
  • method code는 method 선언보다 한 수준 들여쓴다.
  • block code는 block을 포함하는 코드보다 한 수준 들여쓴다.
• 들여쓰기한 파일은 구조가 한눈에 들어온다.
  • 변수, 생성자 함수, 접근자 함수, 메서드가 금방 보인다.

들여쓰기가 되어 있지 않는 코드는 의도적으로 정렬한 내용이 아니라면 수정이 필요한 구간을 드래그로 감싼 뒤 ctrl + alt + L 을 누릅니다. 들여쓰기가 없는 코드는 구간을 확인하기 너무 어렵기 때문입니다.

개인적으로는 if 문의 경우도 한 줄 명령이라도 {} 으로 감싸서 구현하는데, 한 줄 이상 넘어가면 브라켓을 씌워야하기 때문이기도 하고 if문을 명확히 구분하고 싶은 의도로 감싸서 작성하게 되었습니다.

팀 규칙

• 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
  • 어디에 괄호를 넣을 것인가?
  • 들여쓰기는 몇 자로 할 것인가?
  • 클래스와 변수, 메서드 이름은 어떻게 지을 것인가?
• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
  • 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억할 것!
  • 스타일은 일관적이고 매끄러워야 한다.
  • 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.
  • 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.

결국 형식을 맞추는 중요한 이유는 혼자서 개발하는 것이 아닌 여럿이 팀에 속해 개발을 하기 때문이라 생각합니다. 제 스스로도 어제의 '나'와 내일의 '나' 가 작성한 코드가 다르게 느껴지기도 하는데 다른 사람과의 협업을 하면서 서로의 스타일로 코드가 작성된다면 로직 해결 뿐 아니라 의사소통을 위해 시간과 노력을 추가로 들여야 할 것이기 때문입니다.