5장. 형식 맞추기
적절한 행 길이를 유지하라
JUnit, FitNesse 등 커다란 시스템을 가진 모듈들도 파일 하나당 최대 행이 200줄 미만이다.
즉, 200줄 미만의 파일 구성으로도 충분히 커다란 시스템을 구축할 수 있다.
물론 반드시 지킬 엄한 규칙은 아니고 바람직한 규칙일 뿐이다.
일반적으로 작은 파일이 큰 파일보다 이해하기 쉽다.
신문 기사처럼 작성하라
이름은 간단하면서도 설명이 가능하게 짓자
(이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 쓰자)아래로 내려갈수록 의도를 세세호게 묘사하자
(마지막에는 가장 저차원 함수와 세부 내역이 나온다.)
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽힌다.
일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀접도는 연관성을 의미한다.
서로 밀접한 코드 행은 세로로 가까이 놓이는것이 좋다.
수직 거리
서로 밀접한 개념은 세로로 가까이 둬야 한다.
코드리뷰를 할 때 이 함수에서 저 함수로 오가며 소스파일을 위아래로 뒤져본 경험이 있을 것이다.
또는 함수나 변수가 정의된 코드를 찾으려고 상속 관계를 줄줄이 거슬러 올라간 경험도 있을 것이다.
타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다.
- 변수 선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다.
- 인스턴스 변수 : 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다.
- 종속 함수 : 함 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 먼저 배치한다.
- 개념적 유사성 : 종속적인 관계가 없더라도 같은 변수를 사용하거나 비슷한 기능을 한다면 가까이 배치한다.
가로 형식 맞추기
짧은 행이 바람직하다. 100~120자 정도면 나쁘지 않다.