[클린코드] 5장. 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.

코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.

코드 형식은 의사소통의 일환이며, 의사소통은 전문 개발자의 일차적인 의무이다.

 

원활한 소통을 장려하는 코드 형식을 위한 원칙

 

 1. 적절한 행 길이를 유지하라.

    - 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

 

2. 신문기사 처럼 작성하라.

    - 독자는 위에서 아래로 기사를 읽는다.

      => 코드는 위에서 아래로 읽는다.

    - "제목"은 기사를 간단히 요약한다.

      => 함수명을 통해 원하는 기능을 간단히 요약한다.

    - "첫문단"은 전체 기사를 요약하고 커다란 그림을 보여준다.

      => 함수명과 관련된 개념과 알고리즘에 대한 설명을 보여준다.

    - 아래로 내려갈 수록 날짜, 이름, 발언, 주장, 기타 세부사항등을 알 수 있다.

      => 개념과 알고리즘에 대한 세부적인 구현.

 

3. 개념은 빈 행으로 분리하라.

   - 일련의 행 묶음은 완결된 생각 하나를 표현한다.

   - 패키지 선언부, import 문, 각 함수 사이에는 빈행을 통해 새로운 개념이 시작한다는 시각적 단서를 제공해야 한다.

 

4. 밀접한 코드는 세로로 가까이 놓아라.

    - 코드가 한눈에 들어오게 하기 위해 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

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

    - 단, 인스턴스 변수는 클래스의 맨 처음에 선언하는 것이 규칙이다.

    - 한 함수가 다른 함수를 호출한다면 두 함수를 가까이 배치 해야 한다.

      이때, 호출되는 함수를 호출하는 함수보다 아래에 배치 해야 자연스럽게 읽힌다  (코드는 위에서 아래로 읽으므로)