[클린코드] 4강 주석

주석을 추가하는 이유?

• 우리의 코드 품질이 나쁘기 때문이다! 주석이 없이도 충분한 설명이 되는 코드가 좋은 코드이다.
• 주석은 코드와 다르게 한번 작성하고 나면 방치될 수 있다. 처음에는 코드를 잘 설명했지만 시간이 지날수록 거짓된 정보를 제공할 가능성이 있다.

좋은 주석이란?

• 구현에 대한 정보를 제공 : 정규표현식의 경우에는 한번에 이해하기 어렵다. 주석으로 자세히 설명을 달아주자
• 의도와 중요성을 설명하는 주석

TODO , FIXME

TODO는 미래에 작성해야 하는 코드에 대한 설명을 적는다.

FIXME는 문제가 되지만 당장은 고치지 않는 코드를 적는다.

📚 JavaDocs

현업에서 타 부서에게 코드를 보여준다면 JavaDocs로 자세한 설명을 달아놓는것이 좋다.