5장 형식 맞추기

다음은 로버트 C. 마틴 Clean Code(클린 코드)를 읽고, 정리한 내용입니다.

 

 

---

적절한 행 길이를 유지하라

500줄을 넘어가지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다. 반드시 지킬 엄격한 규칙은 아니지만, 바람직한 규칙으로 삼았으면 좋겠다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

수직거리

서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만, 타당한 근거가 없다면, 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다. 
(protected 변수 : 자식 클래스가 부모 클래스의 멤버(변수나 메서드)에 접근하거나 수정해야 할 때 protected 접근 제어자를 사용)

변수선언
변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역변수는 각 함수 맨 처음에 선언한다

루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다

아주 드물지만, 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다


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


종속 함수
한 함수가 다른 함수를 호출한다면, 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.