[Book][Clean Code][TIL] 책 리뷰 05

Clean Code 클린코드 TIL(Today I Learned) 2022.02.26

📖 DAY 5

📝 오늘 읽은 범위

5장. 형식 맞추기

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

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. (p.96)
• 코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
• 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확정성에 계속 영향을 미친다.
• 💡장려하는 코드 형식

  • 적절한 행 길이 : 500줄을 넘지 않고 대부분 200줄정도
  • 신문 기사처럼 작성하라 : 기사는 아주 짧고, 첫 문단은 전체 기사 내요을 요약한다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다. (p.98)
  • 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
  • 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다. (p.100)
  • 변수는 사용하는 위치에 최대한 가까이 선언한다. (p.101)
  • 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. (여전히 논쟁 : C++ - 가위 규칙(인스턴스 변수를 클래스 마지막에 선언 / 자바 : 클래스 맨 처음에 선언)
  • 한 함수가 다른 함수를 호출한다면(종속 함수) 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. (p.104)
  • 개념적인 친화도가 높을수록 코드를 가까이 배치한다. (p.106)

    친화도가 높은 요인 :
    1. 종속성 2. 변수와 그 변수를 사용하는 함수 3. 비슷한 동작을 수행하는 일군의 함수

  • 가장 중요한 개념을 가장 먼저 표현한다. (p.107)
  • 가로 행은 짧은 행이 바람직하다. 이 글의 저자는 120자 정도로 행 길이를 제한한다. (p.108)
  • 가로는 공백을 사용해 밀접한 개념(공백 X)과 느슨한 개념(공백 O)을 표현한다.
  • 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다. (p.111)

• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다. (p.114)

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

• 팀원들끼리 규칙을 정해 이에 따라 코드를 작성해야 한다는 것에 공감한다. 규칙을 정하지 않고 코드를 작성했을 때, 스타일이 모두 달라 난잡해지는 경우가 있어 일관성있는 형식을 사용하는 것이 좋을 것 같다.
• 장려하는 코드 형식 중에서 “호출하는 함수를 호출되는 함수보다 먼저 배치한다.” 가 가장 인상 깊었다. 이전에 호출되는 함수를 찾았더니 간격이 200줄 이상이라 왔다갔다 하는데 힘들었던 기억이 있다. 위에서 아래로 매끄럽게 읽히는, 가독성이 좋은 코드를 짜도록 노력해야겠다.

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

• 인스턴스 변수 vs 클래스 변수 🔎 설명 참고

#코딩 #개발자 #노마드북클럽 #노개북 #clean_code