(클린코드) 5장. 형식 맞추기

5장.형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 킴으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야한다.

형식을 맞추는 목적

적절한 행 길이를 유지하라

신문기사 처럼 작성하라

이름은 간단하면서도 설명가능하게 짓는다. 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원함수와 세부내역이 나온다.

 

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서다.

 

세로 밀집도

세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드행은 세로로 가까이에 놓여야한다.

 

수직거리

• 변수 선언
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수
  • 클래스 맨 처음에 선언한다.
• 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이에 배치한다.
• 개념적 유사헝

가로 형식 맞추기

가로 공백과 밀집도

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

private void measureLine(String line){
	lineCount++;
	int lineSize = line.length();
	totalChars += lineSize;
	lineWidthHistogram.addLine(lineSize, lineCount);
	recordWidestLine(lineSize);
}

할당 연산자를 강조하려고 앞뒤에 공백을 줬다. 할당문은 외쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣어 두 가지 요소가 나뉜다는 사실을 극명히 한다.

연산자 우선순위를 강조하기 위해서도 공백을 사용한다. (불행히도, 코드 형식을 자동으로 맞춰주다가 공백이 없어지긴한다..ㅠ)

 

가로 정렬

public class FitNesseExpediter implements ResponseSender
{
	private   Socket         socket;
	private   InputStream    input;
	protected long           requestParsingTimeLimit;
//...
	public FitnesseExpediter(Socket    s,
														FitNesseContext context) throws Exception
	{
		this.context =            context;
		socket =                  s;
		requestParsingTimeLimit = 1000;
	}
}

 

별로 유용하지 못하다. 선언부를 읽바보면 변수 유현은 무시하고 이름부터 읽게된다. 할당연산자 보다는 피연산자에 눈이 간다. 심지어, 코드 형식을 맞춰주는 도구는 대다수가 이런 정렬을 무시한다.

따라서 더 이상 가로 정렬하지 않는다. 선언문과 할당문을 별도로 지정하지 않는다.

정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이이지 정렬부족이 아니다. 차라리 클래스를 쪼개야한다.

 

들여쓰기

들여쓰기를 한 파일은 구조가 한눈에 들어온다. 반면 들여쓰기 하지 않은 코드는 열심히 분석하지 않는 한 이해하기 어렵다.

• 들여쓰기 무시하기.
  • if, while, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹인 생기지만, 다시 원점으로 돌아가 들여쓰기를 넣는다. 한 행에 범위를 뭉뚱그린 코드를 피한다.

가짜 범위

빈 while문이나 for문을 접한다. 이런 구조를 가능한 피하려 애쓴다. 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다. while문 끝에 세미콜론 하나를 살짝 덧붙인 코드로 수없이 골탕을 먹었다. 차라리 새 행에 제대로 들여써서 넣어주자.

while (dis.read(buf, 0, readBufferSize)!= -1)
;

팀 규칙

좋은 소프트웨어 시스템은 읽기 쉬운 쿤서로 이루워진다는 사실을 기억하기 바란다.

스타일은 일관적이고 매끄러워야 한다. 한 소스파일에서 봤던 형식을 다른 소스파일에도 쓰이리라는 신뢰감을 독자에게 줘야한다.