클린코드 북클럽 TIL #05

클린코드 북클럽 - Day 4

🏷️ 오늘 읽은 범위: 4장 주석

책에서 기억하고 싶은 내용

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다 (p.69)

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. (p.86)

• 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다. (o.89)

오늘 읽은 소감

• 코드로 의도를 표현한다면 주석은 필요없다고 했다. 여태껏 주석을 작성하지 않았는데 코드로 의도를 파악하기 어렵고 주석조차 없었다면..? 나 스스로와 코드를 읽는 사람에게 사과를 전한다.
• 팀원이 만들어 놓은 커스텀 훅을 사용해야 했는데 IDE가 작성된 주석(사용밥)을 보여줘서 편리했던 경험이 있다. 코드를 살펴보기 전에 주석으로 도움을 얻어 코드를 살펴볼 때 도움이 되었다. 자세히 살펴보지 않아도 팀원에게 도움을 줄 수 있는 주석은 필요하다 생각한다. 물론 코드는 잘 작성된 것을 전제로.
• 추가 정보는 문서와 소스 코드 관리 시스템을 최대한 이용하는 편이 좋겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용

• 리팩토링 과정에서 코드가 변경될 때 주석도 함께 수정해야 하는지 아니면 주석을 아예 없애는 것이 더 나은지?
• 주석은 변명이고, 코드로 표현하기를 애써야 한다고 받아들였다. 주석과 코드가 일치하지 않고 주석이 코드의 변경사항을 따라갈 수 없으니까. 그렇다면 커밋 메시지와 PR에 달면?

나의 최애 북틸

최애 독서 감상문을 쓴 딱 3명만 찾아보세요.

1. 노개북 IT 5분 잡학사전 1일차 - 소감을 읽고 싶게 작성을 잘하셨다!
2. [TIL] 클린코드(Clean Code) - 4장. 주석 - 내용 정리를 무척 잘 해주셨고 내용을 풍부하게 작성하셨다!
3. 클린코드 Day 7-8. 주석 쓰는 방법 - 내용이 한 눈에 들어와 글을 읽기 쉬웠다!

#노개북 #노마드코더 #개발자북클럽