<aside> 💡 ***나쁜 코드에 주석을 달지 마라. 새로 짜라.
</aside>
지금까지 항상 내 코드를 다른사람이 보고 편하게 사용하라고, 이거 내가만든거라고 주석을 길게 작성했다. 누가 만든거거 왜만든거고 어떻게 돌아가고 어떤 파라미터가 어떤 형태인지까지..
심지어 로직의 플로우까지 case 별로 작성하기도 했다. 그리고 그런 내가 꼼꼼하다고 생각을 했었다.
하지만, 책에서는 내 의도를 코드로 설명하지 못해 주석으로 설명한다는 것 자체가 코드가 문제가 있다는 점이라는것을 지적한다.
개발자로써 내가 하고싶은 말은 코드로써만 풀어 나가야하며 코드로 풀 수 없는 내 의도나 정보들에 대해서만 주석을 작성할 수 있도록 하자.
: 주석이 길어질수록 자신의 코드가 알아먹기 힘들다는것을 말해주는 것 밖에 되지 않는다.
주석이 길어진다 싶으면 코드를 새로 리팩토링하거나 짜는게 맞지않나 고려하자.