[클린 코드 읽고 정리해두고 다시 보기] 형식 맞추기

inho ha·2024년 9월 16일
1

형식을 맞추는 목적

  • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

적절한 행 길이를 유지하라

  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
  • 신문 기사처럼, 파일 이름을 명확하게 작성, 첫 부분은 고차원 개념과 알고리즘을 설명, 아래로 내려갈수록 의도를 세세하게 묘사, 마지막에는 가장 저차원의 함수와 세부 내역 작성
  • 행 묶음은 완결된 생각 하나를 표현하고, 생각 사이는 빈 행을 넣어 분리하라
  • 서로 밀접한 행은 가까이 놓여야한다.
  • 변수는 사용하는 위치에 최대한 가까이 선언
  • 인스턴스 변수는 쉽게 찾을 수 있도록 클래스 맨 처음에 선언한다.
  • 한 함수가 다른 함수를 호출한다면 호출하는 함수를 먼저 배치하고, 두 함수는 세로로 가까이 배치한다.
  • 비슷한 동작을 수행하는 개념적 유사성이 높은 코드는 가까이에 배치한다.

가로 형식 맞추기

  • 요즘은 모니터가 크기 때문에 120자 정도로 행길이를 제한한다.
  • 연산자 우선순위를 강조하기 위해서 우선순위 높은 연산은 공백없이 사용할 수 있다.
  • 가로 정렬은 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려진다.
  • 스코프를 나타내는 들여쓰기는 파일 구조를 한눈에 들어오게 해준다.

팀 규칙

  • 여러 스타일을 섞으면 복잡한 코드가 된다.
  • 일관된 스타일로 작성하여 다른 파일도 같은 스타일로 작성될 것이라는 신뢰감을 줘야한다.
profile
inho ha / ian(swatchon) / iha(42seoul)

0개의 댓글