[CLEANCODE] 주석

주석을 최대한 쓰지 말자

• 주석은 나쁜 코드를 보완하지 못한다
• 주석은 방치된다

주석은 나쁜 코드를 보완하지 못한다

• 주석이 추가되는 일반적인 이유는 코드 품질이 나쁘기 때문임
• 좋은 코드로 주석 없이 의도를 표현 할 수 있음
• 주석으로 설명하지 말고 코드를 개선하는데 시간을 투자해야함

주석은 방치된다

• 코드의 변화에 따라가지 못하고, 방치
• 코드는 컴파일 되어 호출되지만, 주석은 그자리에 방치되고 결국 의미없는 텍스트가 됨

---

좋은 주석

• 의도와 중요성을 설명
• TODO, FIXME 주석

의도와 중요성 설명

// 사용자로부터 입력 받은 값을 저장할 때 trim으로 공백제거 필요
String name = nameInput.trim();

• 의도와 중요한 부분을 설명해주는 것은 좋은 주석

TODO, FIXME

• TODO : 앞으로 할일, 지금은 해결하지 않지만 나중에 해야할일을 미리 적어둘 때
• FIXME : 문제가 있지만, 당장 수정할 필요가 없을 때

---

주석보다 Annotation

주석보다 Annotation을 사용하는 것이 좋음, 코드 실행 흐름에 간섭을 주기도 하고, 코드에 대한 정보를 줄 수 있기 때문

• @Depreacted : 컴파일러가 warning 발생시키며, 더이상 사용하지 않는 코드인 경우 사용
• @NotThreadSate : 쓰레드 세이프하지 않음을 나타냄