오늘 읽은 범위 : 4장오늘의 TIL 3줄 요약
•
주석이 필요해진다면 그것은 좋은 코드가 아니다.
•
왠만하면 코드로 의도를 표현하는 것이 좋다.
•
주석에도 그나마 좋은 주석과 그렇지 않은 주석이 있다.
책에서 기억하고 싶은 내용
좋은 주석
1.
정보를 제공하는 주석
•
필요할 수도 있지만 코드로 표현이 가능한 수준까지는 작성하고 그래도 부족하다면 작성
2.
의도를 설명하는 주석
3.
의미를 명료하게 밝히는 주석
•
인수나 반환값이 표준 라이브러리일 때 주석이 유용함.
4.
결과를 경고하는 주석
•
예를 들면, 테스트 케이스를 꺼야하는 이유가 포함된 주석.
5.
TODO 주석
6.
중요성을 강조하는 주석
7.
이 외의 주석들은 좋지 않은 주석들
책 읽은 소감
지금까지 주석을 그렇게까지 활용한 적은 없었다. 프로젝트 할때도 Todo정도는 적었던 적이 있었지만
대부분의 코드에 주석이 없었다. 그래서 주석을 작성하는 부분들을 잘 기억해서 쓰는 일들이 없도록
하는 것이 좋을 것 같다.
이 책에서 비교하는 부분들이 굉장히 극단적인 느낌이 나기는 하지만 깔끔하고 보기 좋은 코드를 작성하기
위해서는 필요한 부분들인 것 같다.
#노개북 #개발자북클럽