목록주석 (1)

욱'S 노트

Clean Code - 주석

코드는 항상 변화하고 진화한다. 불행하게도 주석은 언제나 따라 가지는 않는다. 주석은 필요악이다. 주석은 나쁜 코드를 보완하지 못한다. 자신이 저지른 난장판을 주석으로 설명하려 하는 대신에 그 난장판을 깨끗이 치워라. 코드로 의도를 표현하라. 코드를 주석으로 설명하지 말고, 더 명확하게 클래스나 함수로 표현해라. 좋은 주석 라이선스에 관한 주석을 붙이는 것은 타당하다. 의도를 설명하는 주석은 옳을 수 있다. 앞으로 할 일을 TODO 주석으로 남겨두면 편하다. 공개 API를 구현했다면 Javadocs를 남겨야 한다. 나쁜 주석 주절거리는 주석.코드의 내용을 그대로 설명하는 주석은 필요가 없다.자바docs를 만들기 위한 의무적인 주석도 좋지 않다. /**** @param title CD 제목*/ 이력을 기록..
Methdology/Clean Code 2015. 7. 8. 18:57
Prev 1 Next