[클린 코드 (Clean Code)] Ch5. 형식 맞추기

Ch5. 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

• 코드 형식은 중요하다!
• 코드 형식은 의사소통의 일환. 의사소통은 전문 개발자의 일차적인 의무

적절한 행 길이를 유지하라

• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉬움

  • e.g. 한 파일에 200줄 씩으로도 커다란 시스템을 구축할 수 있음

• 신문 기사처럼 작성하라

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

• 개념은 빈 행으로 분리하라

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

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

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

      // 패키지 선언부와 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{
              ...
              ...
          }
    
          public String render() throws Exception {
              ...
              ...
          }
      }
    

• 세로 밀집도

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

• 수직 거리

  • 서로 밀접한 개념은 세로로 가까이 둬야 한다.

  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.

    • 연관성이란 한 개념을 이해하는데 다른 개념이 중요한 정도다.
    • 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

  • 변수 선언

    • 변수는 사용하는 위치에 최대한 가까이 선언한다.
    • 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.

  • 인스턴스 변수

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

      위키독스

      • 파이썬에서의 클래스 변수와 인스턴스 변수 참고

  • 종속 함수

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

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

    • 그러면 프로그램이 자연스럽게 읽힌다.

      • e.g. FitNesse 에서 가져온 코드

          public class WikiPageResponder implements SecureResponder {
              protected WikiPage page;
              protected PageData pageData;
              protected String pageTitle;
              protected Request request;
              protected PageCrwaler 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 makePageResponse(context);
              }
        
              private String getPageNameOrDefault(Request request, String defaultPageName){
                  ...
                  ...
              }
        
              protected void loadPage(String resource, FitNessContext context){
                  ...
                  ...
              }
        
              private Response notFoundResponse(FitNesseContext context, Request request)
                  throws Exception {
                  ...
              }
        
              private SimpleResponse makePageResponse(FitNesseContext context)
                  throws Exception{
                  ...
              }
          }

        • 첫째 함수에서 가장 먼저 호출하는 함수가 바로 아래 정의된다.
        • 다음으로 호출하는 함수는 그 아래에 정의된다.
        • 그러므로 호출되는 함수를 찾기가 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.

  • 개념적 유사성

    • 개념적인 친화도가 높은 코드는 서로 끌어당긴다,
    • 친화도가 높은수록 코드를 가까이 배치한다.

가로 형식 맞추기

• 한 행은 가로로 얼마나 길어야 적당할까?

• 프로그래머는 명백하게 짧은 행을 선호

• 가로 공백과 밀집도

• 가로 정렬

    public class FitNesseExpediter implements ResponseSender
    {
        private  Socket         socket;
        private  InputStream    input;
        private  OutputStream   output;
    }

  • 이와 같은 정렬은 코드의 엉뚱한 부분을 강조해 진짜 의도가 가려진다.
  • 이처럼 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.

• 들여쓰기

  • 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

  • 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.

  • 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.

  • 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

  • 들여쓰기 무시하기

    • 때로는 간단한 if 문, 짧은 while 문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생긴다.

    • 이런 유혹에 빠질 때마다 항상 원점으로 돌아가 들여쓰기를 넣는다.

    • 즉 한 행에 범위를 뭉뚱그린 코드를 피한다

        public class CommentWidget extends TestWidget
        {
            public static final String REGEXP = "..."
      
            public CommentWidget(ParentWidget parent, String text){super(parent, text);}
            public String render() throws Exception {return "";}
        }
      
        // 위의 코드를 들여쓰기하여 아래와 같이 변경한다.
        public class CommentWidget extends TestWidget
        {
            public static final String REGEXP = "..."
      
            public CommentWidget(ParentWidget parent, String text){
                super(parent, text);
            }
      
            public String render() throws Exception {
                return "";
            }
        }

• 가짜범위

  • 때로는 빈 while 문이나 for 문을 접하는데, 이럴 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.

팀 규칙

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