클린코드 5 - 형식 맞추기

yesjm·2024년 4월 18일
0

클린코드를 읽자

목록 보기
5/13

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

적절한 행 길이를 유지하라

  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다
  • 신문 기사처럼 작성하라

개념은 빈 행으로 분리하라

  • 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다

세로 밀집도

  • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
  • 서로 밀접한 개념은 세로로 가까이 둬야 한다.

변수 선언

  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 인스턴스 변수는 클래스 맨 처음에 선언한다(잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요함)

종속 함수

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

개념적 유사성

  • 개념적 친화도가 높은 코드일수록 가까이 배치한다.
    - 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
    • 변수와 그 변수를 사용하는 함수
    • 비슷한 동작을 수행하는 일군의 함수

가로 형식 맞추기

  • 120자 정도로 행 길이를 제한

가로 정렬

  • 선언문과 할당문을 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다
    정렬이 필요할 정도로 선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

  • 들여쓰기 하지 않은 코드는 열심히 분석하지 않는한 거의 불가해하다.
  • 짧은 if, while, 함수에서 들여쓰기를 무시하고 싶은 유혹에 빠지지 말자

팀 규칙

  • 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하자
profile
yesjm's second brain

0개의 댓글