[5장] 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜고 규칙을 착실히 따라야한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야한다.
형식을 맞추는 목적
코드 형식은 중요하다! 코드의 형식은 의사소통의 일환이다. 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
적절한 행 길이를 유지하라
세로 길이 JUnit, FitNesse, testBG, Time and Money(tam), JPepend, Ant, Tomcat의 프로젝트 7개를 조사한 결과 Java 기준, 500줄을 넘지 않고 대부분 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));}
public String render() throws Exception {
StringBuffer html = new StringBuffer("<b>");
html.append(childHtml()).append("</b>");
return html.toString();
}
}
좋은코드 빈 행을 넣은 경우
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();
}
}
세로 밀집도
줄 바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미힌다. 즉, 서로 연관성이 있는 코드는 세로로 가까이 놓아야 한다.
아래 코드와 같이 변수 2개와 함수 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);
}
수직 거리
서로 밀접한 개념은 세로로 가까이 둬야 한다. 타당한 근거가 없다면 사로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만들 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.
loop를 제어하는 변수는 흔히 loop 문 내부에 선언한다.
다소 긴 함수에서 변수는 블록 상단이나 루프 직전에 변수를 선언한다.
// 다소 긴 함수에서 변수 선언
// TestRunner tr = m_runnerFactory.newTestRunner(this, test);
...
for (XmlTest test : m_suite.getTests()) {
TestRunner tr = m_runnerFactory.newTestRunner(this, test);
tr.addListener(m_textReporter);
m_testRunners.add(tr);
invoker = tr.getInvoker();
for (ITestNGMethod m : tr.getBeforeSuiteMethods()) {
beforeSuiteMethods.put(m.getMethod(), m);
}
for (ITestNGMethod m : tr.getAfterSuiteMethods()) {
afterSuiteMethods.put(m.getMethod(), m);
}
}
…
인스턴스 변수는 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
종속 함수는 한 함수가 다른 함수를 호출하면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수는 호출되는 함수보다 먼저 배치한다. 그러면 코드가 자연스럽게 읽힌다.규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 바로 다음에 정의되어 있으리라 예상할 수 있다.
public class WikiPageResponder implements SecureResponder {
protected WikiPage page;
protected PageData pageData;
protected String pageTitle;
protected Request request;
protected PageCrawler crawler;
// public 함수, WikiPageResponder의 instace가 '호출하는' 함수
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 OR protected 함수, makeResponse 함수에서 '호출되는' 함수들
private String getPageNameOrDefault(Request request, String defaultPageName) {
String pageName = request.getResource();
if (StringUtil.isBlank(pageName))
pageName = defaultPageName;
return pageName;
}
protected 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 SimpleResponse makePageResponse(FitNesseContext context)
throws Exception {
pageTitle = PathParser.render(crawler.getFullPath(page));
String html = makeHtml(context);
SimpleResponse response = new SimpleResponse();
response.setMaxAge(0);
response.setContent(html);
return response;
}
개념적 유사성
개념적인 유사도가 높을수록 코드를 가까이 배치한다. 아래는 Junit 코드이다.
- 한 함수가 다른 함수를 호출하는 경우
- 변수와 그 변수를 사용하는 함수
- 비슷한 동작을 수행하는 함수들
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);
}
...
위 함수들은 개념적인 친화도가 매우 높다. 명명법이 똑같고 기본 기능이 유사하고 간단하다. 때문에 종속적인 관계가 없더라도 가까이 배치할 함수들이다.
가로 형식 맞추기
가로 길이는 얼마나 길어야 적당할까? 세로 길이와 똑같이 프로젝트 7개를 조사한 결과, 20자에서 60자 사이가 전체의 40%에 달했다. 요즘에는 모니터 화면이 커서 200자도 넘게 화면에 표시가 가능하지만, 왠만하면 120자 정도로 행 길이를 제한하자. 프로그래머는 명백하게 짧은 행을 선호하므로 짧은 행이 바람직하다.
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다. 다음 함수를 보자.
private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}
- 위 코드는 할당 연산자 좌우로 공백을 주어 왼쪽, 오른쪽 요소를 확실하게 구분한다.
- 함수 이름과 괄호 사이에는 공백을 없애서 밀접함을 보여준다.
//연산자 우선순위 강조를 위한 공백
public static double root2(int a, int b, int c) {
double determinant = determinant(a, b, c);
return (-b - Math.sqrt(determinant)) / (2*a);
}
- 위 코드는 연산자 우선순위 강조를 위한 공백을 주어 수식을 읽기 편하게 한다.
가로정렬
선언부의 변수 이름이나 할당문의 오른쪽 피연산자를 나란히 정렬하는건 유용하지 못하다.
나쁜예시
this.context = contex;
soket = s;
output= s.getOutputStream();
들여쓰기
들여쓰기를 잘하면 구조가 한눈에 들어온다. 때로는 간단한 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(dis.read(buf, 0, readBufferSize) != -1)
;
팀 규칙
팀에 속해있다면, 가장 우선시 되어야 하고 선호해야 할 규칙은 팀 규칙이다.
처음 팀이 이루어졌다면 팀원들과 코딩을 시작하기 전에 코딩 스타일을 의논하여(괄호를 어디에 넣을지, 네이밍은 어떻게 할지, 클래스와 변수, 메서드 이름은 어떻게 지을지 등) IDE Formatter(IDE 코드 형식기)로 지정하여 구현하는 것이 옳은 방식이다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄지고, 읽기 쉬운 문서는 스타일이 일관적이고 매끄러워야 한다.
Reference
- 클린코드 , 로버트C. 마틴
Leave a comment