1. 징후 
   -> 주석 기호(// or */)가 출현

2. 원인
   -> 주석은 대부분 그 코드가 명확하지 않을때 붙인다.
   주석이 유용한 경우는
      1) 코드를 어떤 특정한 방식으로 작성한 이유를 설명하는 케이스 ( 또는 어떤 특정한 방식으로 작성하지 않은 이유를)
      2) 간단 명료하지 않은 알고리즘을 설명하는 케이스

주석으로 표현하는 것보다 코드 자체에 반영하는 것이 좋은 주석도 있음.
어떤 루틴의 목적을 달성하고 싶을때, 주석을 이용해서 나타내는 것보다 이 루틴의 이름으로 나태것도 좋음


3. TODO
    1) 주석이 코드의 일정 부분을 성명하는 경우, Extract Method로 그 블록을 메소드로 꺼낼수 있다.
         새로운 메소드의 이름으로 주석의 의미를 알수 있다.
     2) 주석이 메소드가 하는 일을 설명한다면 그 주석을 새로운 이름의 기초로 삼아 rename Method를 이용한다.
     3) 주석이 선조건(preconditions)을 설명한다면, Introduce Assertion을 이요해 주석을 코드로 대체하는 방안을 고려한다.

4. 효과
     의사소통 증진, 중복을 노출시킬 수 있음.

5. DON'T DO
     자기 역할을 다하는 주석을 삭제하지 말것
신고
크리에이티브 커먼즈 라이선스
Creative Commons License
Posted by 영겁회귀

티스토리 툴바