코딩 썸네일형 리스트형 주석을 달기 어려운 이유 코딩을 하면서 주석을 적절히 잘 달아야 한다는데는 이견이 없을 것이다. 하지만 현실은 주석이 제대로 달린 코드를 찾아보기 어렵다. "주석이 제대로 달렸다"의 애매한 기준을 명확하게 정리해보면 다음과 같습니다. 과도한 주석은 나쁘다. 비용이 너무 많이 들어간다. 소스코드를 활용하고 유지보수하는데 어려움이 없어야 한다. 업데이트가 되어서 소스코드와 일치되어야 한다. 전체적으로 일관된 표준을 지켜야 한다. 주석하나 없이 깨끗한 소스코드나 있어도 소용없는 주석은 개발에 보통 어려움이 있는 것이 아니다. 약간의 시간을 투자해서 주석을 달게 되면 투자대비 몇배의 효과를 볼 수 있다. 그럼 가장 효과적으로 주석을 다는 방법에 대해서 알아보자. 회사의 주석 표준을 정한다. Doxygen이나 Javadoc등의 표준 주석.. 더보기 이전 1 다음
