주석
주석은 필요악이다 - 쓰지 않아도 되는 곳엔 쓰지 않는 게 좋다.
주석은 오래될수록 코드에서 멀어진다. -> 주석까지 유지보수하는 건 힘들기 때문.
주석은 나쁜 코드를 보완하지 못한다
코드 품질이 나쁠 땐 주석을 추가하기보다 코드를 정리해야 한다.
코드로 의도를 표현하라!
주석으로 달려는 설명을 코드로 충분히 표현할 수 있다.
좋은 주석
어떤 주석은 유익할 수도 있다. 하지만, 주석이 없는 게 제일 완벽하다…
- 법적인 주석 : 라이선스 등을 표시한 것
- 정보를 제공하는 주석 : 코드를 통해 설명하기 힘든 정보를 제공하는 주석.
- 의도를 설명하는 주석 : 구현 결정에 깔린 의도를 설명 가능.
- 의미를 명료하게 밝히는 주석 : 모호한 인수나 반환값을 변경하지 못할 경우, 주석으로 밝힐 수 있음(but, 그릇된 주석을 달지 않도록 주의)
- 결과를 경고하는 주석
- TODO 주석 : 앞으로 할 일을 //TODO로 남기면 편함. (요즘 IDE는 TODO주석 전부를 찾아 보여주는 기능 제공)
'독서일지 > 클린 코드' 카테고리의 다른 글
| 클린 코드 독서일지 - Day 9 (0) | 2023.11.02 |
|---|---|
| 클린 코드 독서일지 - Day 8 (0) | 2023.11.01 |
| 클린 코드 독서일지 - Day 6 (0) | 2023.10.31 |
| 클린 코드 독서일지 - Day 5 (0) | 2023.10.29 |
| 클린 코드 독서일지 - Day 4 (0) | 2023.10.27 |