형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 규칙을 정하고 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용하자.

형식을 맞추는 목적

코드 형식은 중요하다. 구현한 기능은 다음 버전에 바뀔 확률이 높다. 그런데 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이

자바에서 파일 크기는 클래스 크기와 밀접하다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다. 클래스를 되도록이면 작게 만들자.

신문기사처럼 작성하라

이름은 간단하면서도 설명이 가능하게 짓자. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하자

각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리하자.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다. 행 사이의 주석도 코드를 한눈에 알아보기 힘들게 하기 때문에 사용하지 않는게 좋다.

수직 거리

서로 밀접한 개념은 한 파일에 속해야 한다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수 선언

변수는 사용하는 위치에 최대한 가까이 선언하자. 지역 변수는 각 함수 맨 처음에 선언한다. 긴 함수에서는 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.

인스턴스 변수

자바에서는 보통 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 대다수 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.

개념적 유사성

어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
친화도가 높은 요인은 여러 가지다.

• 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
• 변수와 그 변수를 사용하는 함수
• 비슷한 동작을 수행하는 일군의 함수

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식

짧은 행이 바람직이다. 행 길이는 120자 정도로 제한하는게 좋다.

가로 공백과 밀집도

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

• 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 그러므로 공백을 넣으면 요소가 확실히 나뉜다는 사실이 분명해진다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다.
• 연산자는 우선순위를 강조하기 위해서 공백을 사용한다.

들여쓰기

범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다. 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다. 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다. 클래스 내 메서드는 클래스보다 한 수준 들여쓴다. 메서드 코드는 메서드 선언보다 한 수준 들여쓴다. 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

팀 규칙

프로그래머라면 각자 선호나는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 팀 규칙이다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 줘야 한다.