Skip to content

Latest commit

 

History

History
336 lines (222 loc) · 9.16 KB

Chapter 5. 형식 맞추기.md

File metadata and controls

336 lines (222 loc) · 9.16 KB
Raw

Chapter 5. 형식 맞추기

  • 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다.

  • 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 따라야 한다.

형식을 맞추는 목적

코드 형식은 중요하다!

코드 형식은 의사소통의 일환이다.

의사소통은 전문 개발자의 일차적인 의무다.

  • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
  • 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

적절한 행 길이를 유지하라

  • 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
  • 큰 파일보다 작은 파일이 이해하기 쉽다.

[신문 기사처럼 작성하라]

  • 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
  • 아래로 내려갈수록 의도를 세세하게 묘사한다.

[개념은 빈 행으로 분리하라]

  • 빈 행은 새로운 개념을 시작한다는 시각적 단서이다.
  • 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
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));
    }
}

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

  • 의미없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았다.

    • 코드가 '한눈'에 들어오지 않는다.
public class ReporterConfig {
    private String m_className;
    private List<Property> m_properties = new ArrayList<Property>();
    public void addProperty(Property property) {
        m_properties.add(property);
    }
}
  • 떨어져 있는 코드에 비해 훨씬 더 읽기 쉽다.
  • 머리나 눈을 움직일 필요가 거의 없으며, 한눈에 변수 2개와 메서드가 1개인 클래스라는 사실을 알 수 있다.

[수직 거리]

  • 서로 밀접한 개념은 세로로 가까이 둬야 한다.
  • 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
    • protected 변수를 피해야하는 이유
      • protected 변수를 사용하면 같은 패키지내에서 쓸 수 있으니까
      • 굳이 protected를 달면서 같은 패키지 안에서 쓰지 말고, 이미 연관성 있는 것이므로 한 파일내에 쓰는 것이 바람직하다

[변수 선언]

  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 지역 변수는 각 함수 맨 처음에 선언한다.
  • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

[인스턴스 변수]

public static class test{
    int instanceVar; // 인스턴스 변수
    static int classVar; //클래스 변수
}
  • 클래스 맨 처음에 선언한다.
  • 변수 간에 세로로 거리를 두지 않는다.

[종속 함수]

  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 호출하는 함수를 호출되는 함수보다 먼저 배치한다. = 자연스럽게 읽힌다.

[개념적 유사성]

  • 친화도가 높을수록 코드를 가까이 배치한다.
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);
    }
}
  • 명명법이 똑같고 기본 기능이 유사하여 개념적인 친화도가 매우 높다.
  • 서로가 서로를 호출하는 관계는 부차적인 요인이므로, 종속적인 관계가 없더라도 가까이 배치할 함수들이다.

[세로 순서]

  • 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
  • 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

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

[가로 공백과 밀집도]

  • 공백을 넣으면 두 가지 주요 요소가 확실히 나뉘다는 사실이 더욱 분명해진다.
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); // 공백 사용
    }
    ...
}

[가로 정렬]

  • 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문에 별로 유용하지 못하다.
  • 정렬이 필요한 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
// bad
public class FitNesseExpediter implements ResponseSender {
    private Socket          socket;
    private InputStream     input;
    private OutputStream    output;
    private long            requestProgress;
  
  	this.context = context;
    socket       = s;
}

// good
public class FitNesseExpediter implements ResponseSender {
    private Socket socket;
    private InputStream input;
    private OutputStream output;
    private Request request;
    private Response response;
    protected long requestParsingTimeLimit;
    private long requestProgress;
    private long requestParsingDeadline;
    private boolean hasError;
}
  • 선언부가 길다면 클래스를 쪼개야 한다는 의미다.

[들여쓰기]

  • 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.

  • 들여쓰기한 파일은 구조가 한눈에 들어온다.

  • 변수, 생성자 함수, 접근자 함수, 메서드가 금방 보인다.

  • 들여쓰기 무시하기

    • 때로는 간단한 if문, 짧은 함수에 들여쓰기를 무시하고픈 유혹이 생긴다.
    //bad
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 ""; } 
}

//good
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)
;

팀 규칙

  • 팀은 한 가지 규칙에 합의해야 한다.
  • 모든 팀원은 그 규칙을 따라야 한다.
  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다.
  • 스타일은 일관적이고 매끄러워야 한다.
  • 한 소스파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야한다.