📘클린코드 (2022.01.30) - 형식 맞추기

DAY 10

오늘 읽은 범위

5장 형식 맞추기 ~p116

😃 책에서 기억하고 싶은 내용을 써보세요.

• 형식을 맞추는 목적

  • 형식은 가독성에 대부분을 차지하고, 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

• 적절한 행 길이를 유지하라

  • 200줄 정도의 파일로도 커다란 시스템을 구축할 수 있다.

• 신문 기사처럼 작성하라

  • 이름은 이름만 보고도 올바른 모듈인지 아닌지를 판단 가능할 정도로 짓는다
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하라
  • 아래로 내려갈수록 의도를 세세하게 묘사하라
  • 마지막에는 가장 저차원 함수와 세부 내역을 작성하라

• 개념은 빈 행으로 분리하라

  • 패키지 선언부, import 문, 각 함수등 개념이 나뉘는 곳에 빈 행을 추가하라
  • 빈 행은 새로운 개념이 시작된다는 시각적 단서이다.

• 세로 밀집도

  • 빈 행이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
  • 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

• 수직 거리

  • 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 파악하기 힘들다.

• 변수 선언

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

• 인스턴스 변수

  • 인스턴스 변수는 클래스 맨 처음에 선언한다. (c++에서는 클래스 맨 하단에 선언, 중요한건 인스턴스 변수가 모인다는 사실이다.)
  • 변수 간에 세로로 거리를 두지 않는다.

• 종속 함수

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

• 개념적 유사성

  • 세로 밀집도와 유사한 의미이다. 개념적 친화도가 높은 코드를 가까히 배치한다.
  • 종속 함수, 비슷한 동작을 수행하는 함수 등이 친화도가 높은 예이다.

• 가로 형식 맞추기

  • 행의 길이는 120자 정도로 제한한다.

• 들여쓰기

  • 스코프로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
  • 들여쓰기가 잘된 코드는 구조가 한눈에 들어오고 변수, 함수, 메서드가 잘 보인다.

🙄오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 평소 코드를 작성할때 많이 신경썼던 부분이라서 전체적인 내용은 이해가 잘되었다. 하지만 개념적 유사성이 깊은 코드는 서로 가까히 배치하고 종속 함수일 경우 호출하는 함수를 먼저 배치하는 내용은 중요한 내용인데 모르고 있었다. 마구잡이로 함수를 작성하는것이 아닌 책대로 고차원에서 저차원으로 읽힐 수 있는 코드를 짤 수 있게 되었다.

✏ 소감 3줄 요약

• 고차원에서 저차원으로 구성되도록 코드를 작성하자.
• 가독성은 앞으로 바뀔 코드의 품질을 결정한다.
• 개념적 친화도가 높은 코드를 서로 가까히 배치하자.