3장 - 주석
소감
주석이랑 코드랑은 별개로 움직여서 코드와의 동기화(?)를 개발자가 직접적으로 신경써야 하는 부분이 단점으로 느껴지긴 하지만 개인적으로 다른 사람이 읽었을때 혼란스럽게 만드는 주석외에는 다 좋은 주석이지 않을까 생각이 됩니다.
물론 주석이 없어야 명확하고 잘짠 코드라고 할수 있겠지만, 실무를 진행하다 보면 한번에 좋은 코드를 짜기란 어렵기 때문입니다. 코드가 완벽하지 않아도 주석을 이용해 해당 코드에 대한 이해도를 증가 시킬 수 있는 주석이라면 얼마든지 환영이지만, 나중엔 그 주석을 없앨 수 있도록 리팩토링 하는 습관을 길러야한다고 생각이 됩니다만. 사실 이것또한 쉽지 않은거 같습니다.(실무에서 엄청난 양의 TODO를 목격하였지만 시간이 지나도 그 TODO는 지워지지 않았습니다…)
주석을 사용함으로써 얻는 단점이나 장점은 개인마다 각각의 생각이 있을 수 있으므로 정확하게 가이드 하기는 어렵지만 본인이 필요하다고 생각하는 주석을 작성하고 그 주석이 꼭 필요한지, 다른 방식(함수의 이름을 잘 쓴다던지..) 으로 대체할 수 없는지 고민해보면 주석을 좋은 방향으로 사용할 수 있지 않을까 생각해봅니다.
강의 내용
주석을 최대한 쓰지말자
- 주석은 나쁜 코드를 보완하지 못한다.
- 주석은 방치된다.
좋은 주석
- 구현에 대한 정보를 제공한다. (ex. 정규식)
- 의도와 중요성을 설명한다.
- TODO, FIXME
주석보다 annotation
- @Deprecated
- @NotThreadSafe
JavaDoc