Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 4장. 주석
#clean_code
2년 전
525


TIL (Today I Learned)

// 2022.02.24

오늘 읽은 범위

// 4장. 주석

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

  • 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다. - 68p

  • 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. - 69p

  • 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다. - 76p

  • 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다. - 83p

  • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다. - 86p

  • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. - 89p

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

  • 예전에는 주석을 코드를 보다 이해하기 쉽게 해주는 존재라고 생각했고, 그렇게 착각하고 있었기에 주석을 너무 남발했던 것 같다. 하지만 다시 돌이켜보면, 주석이 코드를 더 잘 이해할 수 있게끔 도와줬다기 보다 주석 없이도 설명을 잘 해줄 수 있는 코드를 작성하지 못했던 것 같다. 그러면서도, 주석을 작성하는 데 적은 시간만 들이는 바람에 코드를 더 이해하기 어렵게 만들거나, 다른 부분을 참조하지 않으면 이해하기 어려운 주석을 쓰거나, 주석을 수정하지 않은 채로 코드만 업데이트 하여 필요 없는 부분을 만들지 않았나하는 반성을 할 수 있었다.

  • 앞으로 주석을 최대한 덜 쓰도록, 만약 쓴다고 하더라도 정말 필요한 경우에만 쓰며, 그 주석이 자신이 맡은 바 역할을 다 할 수 있도록 노력해야겠다고 생각했다. 주석이 필요없는 코드를 작성하기 위해 앞선 챕터에서 배웠듯이, 좋은 이름을 짓고, 한 가지 기능만 수행하는 짧은 함수를 만들기 위해 계속해서 연습해야겠다.

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