🪟 5장 형식 맞추기

형식을 맞추는 목적

오늘 구현한 기능은 시간이 지나면서 변하게 될 수 있다. 오늘 작성한 코드는 앞으로 유지보수할 코드의 품질에 지대한 영향을 미칠 수 있다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이 및 확장성에 계속 영향을 미친다.

적절한 행 길이를 유지하라

클린 코드 책에서는 대다수의 코드 파일이 200줄 미만이라고 한다. 이는 대부분 200줄 을 넘어서고 심지어 수천 줄이 넘어가는 파일도 있다는 의미이다.

신문 기사처럼 작성하라

신문 기사의 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다. 날짜, 이름, 발언, 주장, 기타 세부 사항이 나온다. 해당 내용은 코드도 글을 읽는 것처럼 읽힐 수 있도록 하자는 의미로 해석할 수 있다.

개념은 빈 행으로 분리하라

생각 사이는 빈 행을 넣어 분리한다. 빈 행은 새로운 개념을 시작한다는 시각적 단서이다. 코드가 짧으면 상관없을 수 있지만 코드가 길어질수록 빈 행의 구분이 없으면 내용이 눈에 들어오지 않는다.

세로 밀집도

서로 밀접한 코드 행은 세로로 가까이 놓아야 한다.

수직 거리

변수는 사용하는 위치에 최대한 가까이 선언한다.

반면, 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 반드시 클래스 맨 처음에 선언하지 않더라도 코드를 읽는 사람들이 변수 선언이 어디에 있는지는 알 수 있어야 한다.

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

개념적 유사성이 높은 코드를 가까이 배치하라

public class Assert {
	static public void assertTrue(String message, boolean condition) {
		if(!condition)
			fail(message);
	}

	static public viod assertTrue(boolean condition) {
		assertTrue(null, condition);
	}

	static public void assertFalse(String message, boolean condition) {
		assertFalse(message, !condition);
	 }

	static public void assertFalse(boolean condition) {
		assertFalse(null, condition);
	}
...

예를 들면 위 assert 클래스 내부의 메소드들은 유사성이 매우 높다. 명명법이 똑같고 기본 기능이 유사하다는 특징이 있다.

가로 형식 맞추기

한 행의 가로 길이는 어느 정도가 적당한가? 사실 이 부분은 나의 경우 28인치 모니터에 양옆으로 코드 editor를 2개 띄워놓고 코드가 적당히 차면 줄 바꿈을 하거나 가로 길이를 줄이는 방법을 찾곤 했었다. 책을 읽어보니 해당 방식대로 가면 되고 120자 정도만 넘지 않게 작성하라고 충고 해준다.