프로그래머는 자신의 코드에 주석을 달도록 교육받는다. 훌륭한 코드에는 주석이 많다고 배운다. 불행히도 그들은 코드에 왜 주석이 필요한지 배우지 않는다. 나쁜 코드야 말로 많은 주석을 필요로 한다.
Don't repeat yourself 원칙은 낮은 차원의 지식은 그것이 속하는 코드에 놔두고, 주석은 다른 높은 차원의 설명을 위해 아껴두라고 말한다. 그러지 않으면 지식을 중복하게 되며, 변경 할 때마다 매번 코드와 주석 모두를 바꾸어야 한다. 주석은 필연적으로 낡게 될 것이고, 믿을 수 없는 주석은 주석이 전혀 없는 것보다 더 심각한 문제를 만들어 낸다.
Don't repeat yourself 원칙은 낮은 차원의 지식은 그것이 속하는 코드에 놔두고, 주석은 다른 높은 차원의 설명을 위해 아껴두라고 말한다. 그러지 않으면 지식을 중복하게 되며, 변경 할 때마다 매번 코드와 주석 모두를 바꾸어야 한다. 주석은 필연적으로 낡게 될 것이고, 믿을 수 없는 주석은 주석이 전혀 없는 것보다 더 심각한 문제를 만들어 낸다.
|
|||||||||||
'Archive' 카테고리의 다른 글
| 직교적인 설계가 되어있는지 테스트하는 방법 (0) | 2011.10.01 |
|---|---|
| 코드의 직교성의 장점 (0) | 2011.10.01 |
| 어떻게 코드에 중복이 생기는가? (0) | 2011.10.01 |
| 언제 멈춰야 할지 알라 (0) | 2011.10.01 |
| 리소스가 없다고 자꾸 뜰 경우 (0) | 2011.09.29 |