클린 코드 - 5장 형식 맞추기

클린코드 TIL(Today I Learned) - Day5 (2022.02.28)

오늘 읽은 범위

5장. 형식 맞추기

책에서 기억하고 싶은 내용을 써보세요.

• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. (p. 96)
• 소스 파일도 신문 기사와 비슷하게 작성한다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다. (p.98)
• 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다. (p.98)
• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다. (p.100)
• 서로 밀접한 개념은 세로로 가까이 둬야 한다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다. (p.101)
• 변수는 사용하는 위치에 최대한 가까이 선언한다. (p.101)
• 종속 함수. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. (p.104)
• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. (p.106)
• 프로그래머는 명백하게 짧은 행을 선호한다. (p.107)
• 예전에는 오른쪽으로 스크롤할 필요가 절대로 없게 코드를 짰다. 하지만 요즘은 모니터가 아주 크다. 게다가 젊은 프로그래머들은 글꼴 크기를 왕창 줄여, 200자까지도 한 화면에 들어간다. 가급적이면 그렇게 하지 말기를 권한다. 개인적으로는 120자 정도로 행 길이를 제한한다. (p.108)
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. (p.114)

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

• "호출되는 함수를 호출하는 함수보다 나중에 배치한다." 라는 문장이 이번 챕터에 있었다. 파이썬과 같은 인터프리터 언어는 위에서부터 차례대로 코드를 해석하기 때문에 호출되는 함수를 나중에 배치하면 에러가 뜬다. 이 책은 '자바(Java)'언어를 기준으로 쓰여져서 자바를 잘 알지 못하는 독자나 나같이 자바를 싫어하는 독자에게는 좀 아쉽다.
• 코드를 짜다보면 가로줄이 너무 길어져 IDE에 가로 스크롤이 생기는 경우가 가끔있다. 가로 스크롤이 생기면 정말 끔찍하고 유지보수에도 시간이 소요되므로 지양해야겠다.
• "서로 밀집한 개념은 세로로 가까이 둬야 한다." 라는 문장에 매우 동의한다. 항상 코드를 짤 때 밀집한 개념은 최대한 가까이 붙어있게 짰다. 이 책에서도 나와 같은 생각을 서술하고 있어서 뿌듯했다. 앞으로도 이 방식을 계속 사용할 예정이다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• 없다.