뚜껑을 열었을 때 독자들이 코드가 깔끔하고, 일관적이며, 꼼꼼하다고 감탄하면 좋겠다.
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고, 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고, 그 규칙을 따라야 한다.
[형식을 맞추는 목적]
코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도,
맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
[적절한 행 길이를 유지하라]
500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
반드시 지킬 엄격한 규칙은 아니지만, 바람직한 규칙으로 삼으면 좋겠다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
신문 기사처럼 작성하라
독자는 위에서 아래로 신문 기사를 읽는다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다.
소스 파일도 신문 기사와 비슷하게 작성한다.
- 이름은 간단하면서도 설명이 가능하게 짓기
- 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 지어야 함
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하기
- 아래 내려갈수록 의도를 세세하게 묘사하기
- 마지막에는 가장 저차원 함수와 세부 내역이 나오게 하기
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
예를 들어 목록 5-1을 살펴보자.
목록 5-1 BoldWidget.java
package fitnesse.wikitext.widgets;
import java.util.regex.*;
public class BoldWidget extends ParentWidget {
public static final String REGEXP = "'''.+?'''";
public 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();
}
}
패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다.
너무도 간단한 규칙이지만, 코드의 세로 레이아웃에 심오한 영향을 끼친다.
빈 행은 새로운 개념을 시작한다는 시각적 단서이다.
코드를 읽어내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
세로 밀집도
줄바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미한다.
즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
목록 5-3을 살펴보자.
목록 5-3
public class ReporterConfig {
/**
* 리포터 리스너의 클래스 이름
*/
private String m_className;
/**
* 리포터 리스너의 속성
*/
private List<Property> m_properties = new ArrayList<Property>();
public void addProperty(Property property) {
m_properties.add(property);
}
}
의미 없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았다.
목록 5-4를 보면 목록 5-3 보다 훨씬 더 읽기 쉽다는 것을 알 수 있다.
목록 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);
}
}
수직 거리
서로 밀접한 개념은 세로로 가까이 둬야 한다(같은 파일 내에서).
이게 바로 protected 변수를 피해야 하는 이유 중 하나다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
여기서 연관성이란 한 개념을 이해하는데 다른 개념이 중요한 정도다.
연관성이 깊은 두 개념이 멀리 떨어져 있다면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
우리가 만드는 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.
다음 예제들을 살펴보자.
private static void readPreferences() {
InputStream is = null;
try {
is = new FileInputStream(getPreferencesFile());
setPreferences(new Properties(getPreferences()));
getPreferences().load(is);
} catch(IOException e) {
try {
if (is != null) {
is.close();
} catch (IOException e1) {
}
}
}
}public int countTestCases() {
int count = 0;
for (Test each : tests) {
count += each.countTestCases();
}
return count;
}
인스턴스 변수
반면, 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다.
잘 설계한 클래스는 클래스의 많은(혹은 대다수) 메서드가 인스턴스 변수를 사용하기 때문이다.
다음은 Junit 4.3.1에서 가져온 TestSuite 클래스로 코드가 특이하다.
코드를 살펴보면 중간쯤에 인스턴스 변수 두 개를 선언한다.(안 좋다는 뜻인 듯?)
public class TestSuite implements Test {
static public Test createTest(Class<? extends TestCase> theClass,
String name) {
...
}
public static Test warning(final String message) {
...
}
public static String exceptionToString(Throwable t) {
...
}
**private String fName;
private Vector<Test> fTests = new Vector<Test>(10);**
}
종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
목록 5-5를 살펴보자.
목록 5-5 WikiPageResponder.java
public class WikiPageResponder implements SecureResponder {
protected WikiPage page;
protected PageData pageData;
protected String pageTitle;
protected Request request;
protected PageCrawler 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, FitNesseContext context) {
...
}
private Response notFoundResponse(FitNesseContext context, Request request) {
...
}
private SimpleResponse makePageResponse(FitNesseContext context) {
...
}
}
함수 호출 순서대로 함수가 정의된 것을 볼 수 있다. 예를 들어
- getPageNameOrDefault 호출
- loadPage 호출
- notFoundResponse 호출
- makePageResponse 호출
순서대로 makeResponse 내에서 호출이 되었다면, 함수가 정의된 순서도 똑같이 따른다.
즉, 호출되는 함수를 찾기가 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.
개념적 유사성
어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다.
친화도가 높을수록 코드를 가까이 배치해야 한다.
친화도를 높이는 요인은 여러가지다.
앞서 보았듯이 목록 5-5처럼 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예다.
변수와 그 변수를 사용하는 예도 있다.
그 외에도 비슷한 동작을 수행하는 일군의 함수가 좋은 예다.
예를 살펴보자.
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) {
assertTrue(null, condition);
}
}
위 함수들은 개념적인 친화도가 매우 높다. 명명법이 똑같고, 기본 기능이 유사하고 간단하다.
종속적인 관계가 없더라도 가까이 배치할 함수다.
세로 순서
일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
[가로 형식 맞추기]
한 행은 가로로 얼마나 길어야 적당할까?
개인적으로는 120자 정도로 행 길이를 제한한다.
[팀 규칙]
만약 당신이 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
그리고 모든 팀원은 그 규칙을 따라야 한다.
그래야 소프트웨어가 일관적인 스타일을 보인다. 따로국밥은 피하자.
예를 들어
- 어디에 괄호를 넣을지
- 들여쓰기는 몇 자로 할지
- 클래스와 변수와 메서드 네이밍을 어떻게 지을지
이런것들이 있을 것이다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.
온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피하자!
[밥 아저씨의 규칙]
내가 사용하는 규칙은 간단하다.
목록 5-6에 잘 드러난다.
코드 자체가 최고의 구현 표준 문서가 되는 예다.(언제쯤 나도 이렇게 말할 수 있을까…)
목록 5-6
public class CodeAnalyzer implements JavaFileAnalysis {
private int lineCount;
private int maxlineWidth;
private int widestLineNumber;
private LineWidthHistogram lineWidthHistogram;
private int totalChars;
public CodeAnalyzer() {
lineWidthHistogram = new LineWidthHistogram();
}
public static List<File> findJavaFiles(File parentDirectory) {
List<File> files = new ArrayList<File>();
findJavaFiles(parentDirectory, files);
return files;
}
private static void findJavaFiles(File parentDirectory, List<File> files) {
for (File file : parentDirectory.listFiles()) {
if (file.getName().endsWith(".java")) {
files.add(file);
} else if (file.isDirectory()) {
findJavaFiles(file, files);
}
}
}
public void analyzeFile(File javaFile) throws Exception {
BufferReader br = new BufferReader(new FileReader(javaFile));
String line;
while ((line = br.readLine()) != null) {
measureLine(line);
}
}
private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}
private void recordWidestLine(int lineSize) {
if (lineSize > maxLineWidth) {
maxLineWidth = lineSize;
widestLineNumber = lineCount;
}
}
public int getLineCount() {
return lineCount;
}
public int getMaxLineWidth() {
return maxLineWidth;
}
public int getWidestLineNumber() {
return widestLineNumber;
}
public LineWidthHistogram getLineWidthHistogram() {
return lineWidthHistogram;
}
...
}
'Book Notes' 카테고리의 다른 글
| [개발서적] Clean Code 7. 오류 처리 (0) | 2025.10.23 |
|---|---|
| [개발서적] Clean Code 6. 객체와 자료 구조 (1) | 2025.10.22 |
| [개발서적] Clean Code 4. 주석 (0) | 2025.10.21 |
| [개발서적] Clean Code 3. 함수 (0) | 2025.10.21 |
| [개발서적] Clean Code 2. 의미 있는 이름 (0) | 2025.10.20 |