TIL (Today I Learned)
2022.05.02
오늘 읽은 범위
5장. 형식 맞추기
책에서 기억하고 싶은 내용
형식을 맞추는 목적: 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. - 96페이지
적절한 행 길이를 유지하라
신문 기사처럼 작성하라
개념은 빈 행으로 분리하라
세로 밀집도
: 세로 밀집도는 연관성을 의미한다.
수직 거리
: 서로 밀접한 개념은 세로로 가까이 둬야 한다.
변수 선언
: 변수는 사용하는 위치에 최대한 가까이 선언한다.
인스턴스 변수
: 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다.
종속 함수
: 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
개념적 유사성
: 명명법이 똑같고 기본 기능이 유사하고 간단하면 개념적인 친화도가 높다.
세로 순서
: 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
가로 형식 맞추기
: 한 행의 가로로 얼마나 길어야 적당할까? 개인적으로는 120자 정도로 행 길이를 제한한다.
들여쓰기
: 범위(Scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰기한 파일은 구조가 한눈에 들어온다.
밥 아저씨의 형식 규칙
: 코드 자체가 최고의 구현 표준 문서가 되는 것
오늘 읽은 소감은? 떠오르는 생각
형식 또한 가독성에 영향을 미치게 되고 결국에는 유지보수의 용이성에 영향을 미치게 된다. 전체적으로 일관된 규칙을 적용해서 작성해야 하고, 서로 관련있는 것들끼리는 묶어서 표현해줌으로써 한 눈에 들어오게 만들어줘야 한다. 관련이 있다는 것은 개념적으로 유사하거나 호출하거나 호출 당하는 관계에 있다는 것이다. 밥아저씨가 마지막에 제시해준 코드를 보면서 딱 예상한 곳에 예상한 것들이 나와 있어서 보기에 아주 편하다는 느낌을 받는다. 때론 내가 작성하는 코드들을 읽는데도 불편하고 여기저기 찾아다니는 경우가 많았는데 보고 많이 배운다.
댓글