Clean Code, Chapter 5: Formatting #755
Description
Chapter 5 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
형식을 맞추는 목적
코드 형식은 중요하기 때문에 맹목적으로 따르면 안 된다.
코드 형식은 의사소통의 일환이다.
의사소통은 전문 개발자의 일차적인 의무다.
오늘 구현한 기능은 다음 버전에서 바뀔 수 있다.
오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
적절한 행 길이를 유지하라
그림 5-1은 7개의 프로젝트를 조사해 각 프로젝트에서 최대 파일 길이와 최소 파일 길이를 나타낸 것이다.
이 표를 통해 알 수 있는 건 500줄을 넘지 않고 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 점이다.
엄격한 규칙은 아니지만 바람직한 규칙이다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
- 신문 기사처럼 작성하라
- 개념은 빈 행으로 분리하라
- 세로 밀집도
- 수직 거리
- 세로 순서
신문 기사처럼 작성하라
소스 파일도 신문 기사와 비슷하게 작성한다.
이름은 간단하면서 설명이 가능하게 짓는다.
이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
아래로 내려갈수록 의도를 세세하게 묘사한다.
마지막에는 가장 저차원 함수와 세부 내역이 나온다.
개념은 빈 행으로 분리하라
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이에는 빈 행을 넣어 분리해야 한다.
목록 5-1은 패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다.
빈 행은 새로운 개념을 시작한다는 시각적 단서다.
코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
목록 5-2는 목록 5-1에서 빈 행을 빼버린 코드다.
눈의 초점을 흐리게 하고 코드 전체가 한 덩어리로 보인다.
목록 5-1 BoldWidget.java
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();
}
}목록 5-2 BoldWidget.java
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();
}
}세로 밀집도
세로 밀집도는 연관성을 의미한다.
서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.
목록 5-3은 의미 없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았다.
목록 5-4는 주석을 없앴다. 훨씬 더 읽기 쉽고 코드가 한눈에 들어온다.
목록 5-3
public class ReporterConfig {
/**
* The class name of the reporter listener
*/
private String m_className;
/**
* The properties of the reporter listener
*/
private List < Property > m_properties = new ArrayList < Property > ();
public void addProperty(Property property) {
m_properties.add(property);
}
}목록 5-4
public class ReporterConfig {
private String m_className;
private List < Property > m_properties = new ArrayList < Property > ();
public void addProperty(Property property) {
m_properties.add(property);
}
}수직 거리
서로 밀접한 개념은 세로로 가까이 둬야 한다.
타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 한다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽을 때 소스 파일과 클래스를 여기저기 뒤지게 된다.
- 변수 선언
- 인스턴스 변수
- 종속 함수
- 개념적 유사성
변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다.
잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용한다.
인스턴스 변수를 선언하는 위치는 C++과 자바가 다르지만
잘 알려지 위치에 인스턴스 변수를 모은다는 사실이 중요하다.
변수 선언을 어디서 찾을지 모두가 알고 있어야 한다.
종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
규칙을 일관적으로 적용하면 호출한 함수의 정의가 아래에 있다는 걸 예측할 수 있다.
개념적 유사성
어떤 코드는 서로 끌어당기는데 개념적 친화도가 높기 때문이다.
친화도가 높을수록 코드를 가까이 배치한다.
비슷한 동작을 하는 일군의 함수가 좋은 예이다.
assertTrue(String message, boolean condition)
assertTrue(boolean condition)
assertFalse(String message, boolean condition)
assertFalse(boolean condition)이 함수들은 개념적인 친화도가 높다.
명명법이 같고 기본 기능이 유사하고 간단하다.
종속적인 관계가 없더라도 가까이 배치할 함수들이다.
세로 순서
함수 호출 종속성은 아래 방향으로 유지한다.
호출하는 함수를 먼저, 호출되는 함수를 나중에 배치한다.
그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
가로 형식 맞추기
마찬가지로 프로젝트 7개의 행 길이 분포를 조사했다.
45자 근처가 가장 많은 분포고, 20 ~ 60자 사이가 총 행 수의 40%에 달한다.
홀러리스의 80자 제한은 인위적이며
100 ~ 120자도 나쁘지 않다. 그 이상은 주의부족이다.
- 가로 공백과 밀집도
- 가로 정렬
- 들여쓰기
- 가짜 범위
가로 공백과 밀집도
가로 공백으로 밀접한 개념과 느슨한 개념을 표현한다.
private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}할당 연산자 (=, +=) 는 강조를 위해 앞뒤에 공백을 준다.
왼쪽 요소와 오른쪽 요소가 분명히 나뉘므로, 공백을 넣어 확실히 나뉜다는 사실을 분명히 한다.
함수 이름과 이어지는 괄호 사이는 공백을 넣지 않았다. ( addline(lineSize, recordWidestLine(lineSize )
함수와 인수는 밀접하므로 공백을 넣으면 별개로 보인다.
함수를 호출하는 괄호 안 인수는 공백으로 분리한다. (lineSize, lineCount)
쉼표를 강조해 인수가 별개라는 사실을 보여준다.
연산자 우선순위를 위해 공백을 사용한다.
return (-b + Math.sqrt(determinant)) / (2*a);
return (-b - Math.sqrt(determinant)) / (2*a);
return b*b - 4*a*c;승수 사이에 공백이 없는 건 곱셈의 우선순위가 높기 때문이다.
항 사이에는 공백이 들어가는데 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.
가로 정렬
저자가 어셈블리 프로그램을 짜던 시절에 특정 구조를 강조하기 위해 가로 정렬을 사용한 부분이 있다.
그래서 자바 프로그램을 짜면서도 계속해서 선언부의 변수 이름이나 할당문의 오른쪽 피연산자를 빠뜨리지 않고 나란히 정렬했다.
이 정렬은 유용하지 못한데 코드가 엉뚱한 부분을 강조해 진짜 의도를 가리기 때문이다.
코드를 읽으면 변수 유형은 무시하고 변수 이름부터 읽게 된다.
또 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 간다.
IDE를 쓰면 대다수 이런 정렬을 무시한다.
정렬이 필요할 정도로 목록이 길다면 목록의 길이가 문제지 정렬 부족이 아니다.
들여쓰기
소스 파일은 윤곽도outline와 계층이 비슷하다.
파일 전체에 적용되는 정보,
파일 내 개별 클래스에 적용되는 정보,
클래스 내 각 메서드에 적용되는 정보,
블록 내 블록에 재귀적으로 적용되는 정보
계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.
범위로 이루어진 계층을 표현하기 위해 코드를 들여쓴다.
클래스 내 메서드는 클래스 보다 한 수준 들여쓴다.
메서드 코드는 메서드 선언보다 한 수준 들여쯘다.
블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.
코드를 읽을 때 이런 들여쓰기 체계에 의존한다.
왼쪽 기준으로 코드가 속하는 범위를 시각적으로 표현하므로 범위를 이동하는게 쉬워진다.
들여쓰기를 하지 않으면 코드를 읽기란 거의 불가능하다.
들여쓰기 무시하기
가끔 간단한 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 ""; }
}들여쓰기 적용 코드
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문 끝에 세미콜론 하나가 있는 코드가 골탕먹기 좋다.
while (dis.read(buf, 0, readBufferSize) != -1)
;팀 규칙
프로그래머는 각자 선호하는 규칙이 있지만
팀에 속한다면 팀 규칙을 따라야 한다.
팀은 한 가지 규칙에 합의해야 하고 팀원은 그 규칙을 따라야 한다.
그래야 소프트웨어가 일관적인 스타일을 보인다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다.
스타일은 일관적이고 매끄러워야 한다.
한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰인다는 신뢰감을 줘야 한다.
밥 아저씨의 형식 규칙
코드 자체가 구현 표준의 문서가 되는 예로 목록 5-6을 참고한다.
https://github.com/ludwiggj/CleanCode/blob/master/src/clean/code/chapter05/CodeAnalyzer.java