좋은 주석

[클린 코드] 주석(1)

주석은 코드를 부연 설명해주는 역할을 한다. 하지만 주석으로 좋지 않은 방법으로 짜인 코드를 보완하진 못한다. 표현력이 풍부하고 깔끔하게 짜여진 코드는 주석이 사실상 거의 필요가 없다. 간단한 예를 들어보자 //직원에게 복지 혜택을 받을 자격이 있는지 확인한다. if((employ.flags & HOURLY_FLAG) && (employee.age > 65)); if(employ.isEligibleForFullBenefits()); 위 두 if문은 같은 비교를 하지만 누가 봐도 주석을 달지 않고도 코드만으로 의도를 분명히 할 수 있다. 이와 같이 대다수의 경우 주석으로 만들려는 설명을 함수로 풀어 표현하기에 충분하다. 하지만 특정한 경우에는 주석이 필요할 순 있다. 좋은 주석 법적인 주석 - 특정 회사가..