코드 형식은 중요하다.! 너무 중요해서 무시하기 어렵다.
너무나도 중요하므로 융통성 없이 맹족적으로 따르면 안 된다.
코드 형식은 의사소통의 일환이다.
오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다.
그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가동성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
그렇다면 원활한 소통을 장려하는 코드 형식은 무엇일까?
•
적절한 행 길이를 유지하라.!
Junit, FitNesse, Time and Money는 상대적으로 파일 크기가 작다.
500줄 넘어가는 파일이 없으며 대다수가 200줄 미만이다.
반면, Tomcat과 Ant는 절반이상이 200줄을 넘어서고 심지어 수천 줄이 넘어가는 파일도 있다.
우리에게 무엇을 말하느냐고? 500줄을 넘기지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다.
•
신문 기사처럼 작성하라.
이름은 간단하면서도 설명이 가능하게 짓는다.
이름만 보고 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저 차원 함수와 세부 내역이 나온다.
•
개념은 빈 행으로 분리하라.
빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
package fitness.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) throw Exception {
super(parent);
Matcher match = pattern.match(text);
match.find();
addChildWidgets(match.group(1));
}
public String render() throws Exception {
...
}
}
Java
복사
빈행을 빼버린 코드다. 코드 가독성이 현저하게 떨어져 암호처럼 보인다.
package fitness.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) throw Exception {
super(parent);
Matcher match = pattern.match(text);
match.find();
addChildWidgets(match.group(1));
}
public String render() throws Exception {
...
}
}
Java
복사
•
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
•
수직 거리
함수나 변수 정의된 코드를 찾으려고 상속 관계를 줄줄이 거슬러 올라간 경험이 있는가? 결코 달갑지 않은 경험이다.
시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
서로 밀접한 개념은 세로로 가까이 둬야 된다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
•
변수 선언. 변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역변수는 각 함수 맨 처음에 선언한다.
•
인스턴스 변수. 반면 인수턴스 변수(클래스의 멤버 변수)는 클래스 맨 처음에 선언한다.
•
종속 함수. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
•
개념적 유사성. 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 치환도가 높을수록 코드를 가까이 배치한다.
친화도가 높은 요인은 여러 가지다.
1. 한 함수가 다른 함수를 호출해 생기는 직접적인 종속
2. 변수와 그 변수를 사용하는 함수
3. 비슷한 작업을 수행하는 일군의 함수
다음은 Junit 4.3.1에서 가져온 코드이다.
public class Assert {
static public void assertTure(String message, boolean condition) {
if (!condition) fail(message);
}
static public void assertTure(boolean condition) {
assertTure(null, condition);
}
static public void assertFalse(String message, boolean condition) {
assertTure(null, !condition);
}
static public void assertFalse(boolean condition) {
assertFalse(null, !condition);
}
}
Java
복사
•
가로 형식 맞추기
20자에서 60자 사이는 모든 값이 총행 수의 1% 정도다. 그러니까 20자에서 60자 사이인 행이 총행수의 40%에 달한다는 말이다. 10자 미만은 30% 정도로 보인다. 그래프는 로그 스케일이다. 즉, 선형 반비례 그래프로 보이지만 사실은 80자 이후부터는 행 수는 급격하게 감소한다. 프로그래머는 명백하게 짤은 행을 선호한다.
•
가로 공백과 밀집도
가로는 공백 사용해 밀접한 개념과 느슨한 개념을 표현한다. 다음 함수를 살펴보자
private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}
Java
복사
할당 연사자를 강조하려고 앞뒤에 공백을 줬다.
할당 문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다.
공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다.
함수와 인수는 서로 밀접하기 때문이다.
공백을 넣으면 한 개념이 아니라 별개로 보인다.
함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다.
쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
•
팀 규칙
팀 규칙이라는 제목은 말장난이다. 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
결론
형식 맞추기의 가장 중요한 점은 바로 신문처럼 위에서 아래로 정리되게 잘 읽혀야 된다는 것인 것 같다.
위의 예제들을 보면서 어떤 형식들을 어떤 기준으로 묶는지 잘 나와있으며, 나도 잘 익혀놔야겠다.
그리고 무엇보다도 중요한 건 팀 규칙!
팀에 속한다면 내가 선호하는 스타일은 과감하게 버리고 잘 융화되도록 노력하자!