[Clean Code] 5장 | 형식 맞추기

Jiwoo Kim·2020년 11월 13일
0

Clean Code 정독하기

목록 보기
5/13
post-thumbnail

💻 형식을 맞추는 목적

"코드 형식은 의사소통의 일환이다." (p.96)

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

신문 기사처럼 작성하라

"신문이 사실, 날짜, 이름 등을 무작위로 뒤섞은 긴 기사 하나만 싣는다면 아무도 읽지 않으리라." (p.98)

개념은 빈 행으로 분리하라

: 패키지 선언부, import 문, 각 함수 등 개념 사이의 줄바꿈은 가독성을 높인다.

세로 밀집도 & 수직 거리

: 연관성이 높은 코드 행은 세로로 가까이 배치

  • 변수: 사용하는 위치에 최대한 가까이 선언
  • 인스턴스 변수: 잘 알려진 위치에 모아서 선언
  • 종속 함수: 호출하는 함수 다음 호출되는 함수 정의
  • 개념적 유사성: 직접적 종속성 외 명명법, 기본 기능이 유사하면 가까이 배치

세로 순서

  • 고차원 → 저차원
  • 중요한 개념 → 세세한 사항

💻 가로 형식 맞추기

가로 공백과 밀집도

  • 공백을 넣어 요소가 분리되는 사실을 가시화
  • 함수와 인수: 공백 X
  • 연산자 우선순위: 항 사이 공백

가로 정렬

: 유용하지 않음

들여쓰기

: 필수적임

들여쓰기 무시하기

: 짧은 한 줄 짜리 함수에서도 들여쓰기를 해서 제대로 표현

가짜 범위

: 빈 while, for문의 경우 세미콜론(;)은 새 행에 들여쓰기 해야 눈에 띔

💻 팀 규칙

"좋은 소프트웨어 시스템은 읽기 쉬운 문서로... 스타일은 일관적이고 매끄러워야 한다." (p.114)

0개의 댓글