[CLEAN CODE] 형식 맞추기

형식을 맞추는 목적

코드 형식은 중요하다!
코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 높고,
오늘 구현한 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

소스 코드가 얼마나 길어야 적당할까? (세로 길이)
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

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

개념은 빈 행으로 분리하라

거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이는 빈 행을 넣어 분리해야 마땅하다.

package fitnesse.wikitext.widgets;

import java.util.regex.*;

public class BoldWidget extends ParentWidget {
	public static final String REGEXP = "'''.+?'''";
    	// 이하 생략
}

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 뜻이다.

수직 거리

서로 밀접한 개념은 세로로 가까이 둬야 한다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
코드를 읽으려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지며 혼란만 가중되지 않도록.

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

인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언

종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치
또한, 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치

개념적 유사성
친화도가 높을수록 코드를 가까이 배치

• 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 있는 경우
• 비슷한 동작을 수행하는 일군의 함수인 경우

세로 순서

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

가로 형식 맞추기

프로그래머는 명백하게 짧은 행을 선호한다.
120자 정도의 행 길이 제한을 권한다.

가로 공백과 밀집도

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

가로 정렬

public class FitNesseExpediter implements ResponseSender
{
	private		Socket		socket;
    	private		InputStream	input;
        protected	long 		requestParsingTimeLimit;
        private 	long		requestProgress;
}

위와 같이 변수 이름이나 할당문의 오른쪽 피연산자를 빠뜨리지 않고 나란히 정렬했으나,
변수 유형은 무시하고 변수 이름부터 읽게 되고 할당 연산자는 보이지 않고 피연산자에 눈이간다.

코드가 엉뚱한 부분을 강조해 진짜 의도가 가려져서 아래와 같이 바꿨다.

public class FitNesseExpediter implements ResponseSender
{
	private Socket socket;
    	private InputStream input;
        protected long requestParsingTimeLimit;
        private long requestProgress;
}

들여쓰기

범위(Scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
들여쓰기한 파일은 변수, 생성자 함수, 접근자 함수, 메서드가 금방 보여서 구조가 한눈에 들어온다.

들여쓰기 무시하기
간단한 if문, 짧은 while문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생기지만
결국 들여쓰기로 범위를 제대로 표현한 코드를 선호한다.

가짜 범위

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

빈 while문이나 for문의 세미콜론(;)은 새 행에다 제대로 들여써서 넣지 않으면 눈에 띄지 않는다.

팀 규칙

팀은 한 가지 규치엑 합의하고 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 피해야 한다.