[CleanCode]4.주석

주석은 코드로 의도를 표현하지 못해서 사용하므로 실패이다. 

주석은 거짓말을 하는 경우가 많다. 

진실은 오직 code!

 

그럼 좋은 주석은?

1. 법적인 주석 : file 첫머리에 저작권정보와 소유권정보  ->Good

2. 의미를 명로하게 밝히는 주석 : 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다. 

3. 경고하는 주석 

4. todo주석

 

느낀점 

- 이 책에서 말하는 나쁜 주석들은

이제는 형상관리툴로 커버가 가능한 부분들이고, 책 앞부분에 언급된 대로 함수를 쪼개고 이름을 잘 짓는 것 만으로도 없앨수 있는 부분들이 매우 큰 것 같다. 가능하다면 최대한 작성하지 않도록 하는것, 이전에 주석들은 이제는 다른 적절한 방법들로 개선하는 부분이 필요해 보인다.