|| Clean Code || 코드는 신문기사처럼

책 [Clean Code]를 읽고 정리한 내용입니다.

# 오늘 읽은 범위

5장. 형식 맞추기

# 기억하고 싶은 내용

- 형식을 맞추는 목적

• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다. (p.96)
• 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 놓다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. (p.96)

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

• 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다. (p.97)
• 일련된 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다. (p.98)

  • 신문 기사처럼 작성하라
    • 요약을 시작으로 점점 세세하게
  • 개념은 빈 행으로 분리하라
  • 세로 밀집도
    • 서로 밀접한 코드 생은 세로로 가까이 놓여야 한다.
  • 수직 거리
    • 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
  • 변수
    • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 인스턴스
    • 인스턴스 변수는 클래스 맨 처음에 선언한다.
    • 잘 설계한 클래스는 많은 (혹은 대다수) 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
  • 종속 함수
    • 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  • 개념적 유사성
  • 세로 순서

- 가로 형식 맞추기

• 가로 공백과 밀집도
• 가로 정렬
• 들여쓰기
• 들여쓰기 무시하기
• 가짜 범위

# 떠오르는 생각

• 처음 프로젝트를 할 때에는 왜 종속되는 함수를 하위에 작성하는지 이해가 되지 않았다. 그런데 여기서는 왜 그래야 하는지 충분한 이유를 설명해주어서 납득이 되었다.
• 프로젝트를 하면서 함수와 변수의 정렬에 대해 항상 혼란스러운 부분이 있었다. 그 혼란스러운 부분에 대한 답(정렬기준)을 얻은 것 같아 속이 조금 시원하다.

# 궁금 or 잘 이해되지 않는 내용

• 없음