주석은 나쁜 코드를 보완하지 못한다
코드로 의도를 표현하지 못하니, 주석을 사용하는 경우가 많다. 주석이 필요한 상황에서는 상황을 역전해 코드로 의도를 표현하도록 노력해야 한다. 변화하는 코드안에서 주석은 관리되지 못한다.
코드로 의도를 표현하라!
의도를 주석으로 달기 보다는 함수로 만들어 표현하는 등 코드로 표현하라..
좋은 주석
구현한 의도를 주석으로 달거나, 표준 라이브러리여서 의미를 좀더 명료히 표현할 필요가 있는 경우, 결과를 경고하는 경우(멀티쓰레드에 안전하지 않다는 등).
//TODO 주석도 많이 남지 않도록 주기적으로 점검해 없애준다.
중요성을 강조하는 주석은 필요할 때가 있다.
나쁜 주석
코드에 있는 내용을 주석으로 반복할 필요는 없다. 오해할 수 있는 주석도 나쁘며, 의무적으로 달거나 단순 이력을 주석으로 저장하는 것도 피해야 한다. 저자를 기록하는 부분도 git등에서 관리되므로 주석은 불필요하다.
짧은 함수는 긴 설명이 필요없다. 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
반응형