5, 6일차 TIL 주석

DAY 5, 6

오늘의 책 읽기: 4장. 주석 까지

🤓 책에서 기억하고 싶은 내용

코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다.
그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다. 69p

 

이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 76p

 

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지 없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼트리고, 혼동과 무질서를 초래한다. 80p

 

🥰 오늘의 소감

평소 코드를 짜면서 주석을 자주 사용하는 편이라 생각되어 좋은 주석을 어떻게 짜야하는 것일까 궁금했는데, 좋은 주석은 '없는 주석'이라는 것을 보고 과거를 돌아보게 되었다... 좋은 주석에 대해 설명하는 부분에서도 조차 "이렇게 주석을 넣으면 좋지만 코드를 수정하면 주석이 필요없어진다"라는 글이 강조되어 있었다.

 

코드를 읽는 사람을 위해 주석을 쓰는 것은 필요하다고 생각했다. 이런 마음 때문에 넣지 않아도 될 주석들을 열심히 썼었던 것 같다. 하지만 코드를 쓰고 읽는 것은 사람이라는 것을 간과하면 안된다. 도움을 주기 위한 의도로 많은 주석을 달게 되면 오히려 주석을 무시하는 습관에 빠질 수도 있다는 것을 명심해야 겠다.

 

코드 자체만으로도 이해하기 쉽게 짜는 것이 중요하다는 것을 다시금 깨달으면서 이전 3장 함수 내용을 다시 한번 읽어봐야겠다는 생각이 크게 다가왔다.

 

책에 적혀있는 나쁜 주석 예시들을 보고 피식 웃었는데 혹시 나도 누군가가 피식 웃을만한 주석을 썼었는지 되돌아봐야겠다.

 

🤔 궁금한 내용

없음

 

 

나의 최애 북틸

1. https://nlnf.tistory.com/7 minpa님 - 공감되는 글이 많았다

2. https://ujaa.tistory.com/12 이유우자님 - 내용이 깔끔하게 정리되어 있어서 좋았다.

3. https://nomadcoders.co/community/thread/9531 wpghks7님 - 한글, 영어 주석에 대해도 생각해보게 되었다