[Clean Code] Chapter 04

목차

1. 주석을 최대한 쓰지 말자

2. 좋은 주석

3. 주석보다 annotation

4. JavaDoc

---

1.  주석을 최대한 쓰지 말자

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

  - 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 자신이 저지른 난장판을 주석으로 설명하지 말고 개선하는데 시간을 보내야 한다.

  - 코드로도 의도를 표현할 수 있다.

  - 주석은 방치되는 경우가 많다.(코드는 컴파일 되기때문에 계속적으로 관리되지만 주석은 텍스트 그자체이기 때문에 방치될 수 있다.)\

 

2.  좋은 주석

 - 구현에 대한 정보를 제공한다.

 - 의도와 중요성을 설명한다.

 - TODO : 앞으로 할 일, 지금은 해결하지 않지만 나중에 해야할 일을 미리 적어둘 때

 - FIXME : 문제가 있지만, 당장 수정할 필요는 없을 때, 가능하면 빨리 수정하는게 좋다

 

3.  주석보다 annotation

 - 코드에 대한 메타 데이터

 - @Deprecated : 컴파일러가 warning을 발생시킴, IDE에서 사용시 표시됨

 - @NotThreadSafe : Thread Safe하지 않음을 나타냄

 

4. JavaDoc

   /**

     *

     */    <- 이런식으로 사용

 - JavaDoc build 명령어로 JavaDoc이 만들어진다. 문서화된 내용을 따로 볼수가 있다.