프로그래밍 주석에 대한 정리 및 몇가지 팁~

주석이 왜 필요한가? 

프로그래밍을 배울 때 변수, 제어문 등에 앞서 주석을 지정하는 방법에 대해서 가장 먼저 설명하는 것을 볼 수 있습니다. 

특히 예전에는 주석을 잘 활용하는 것이 중요하다는 이야기를 많이 했었는데요. 

요즘에는 프레임워크가 발달하면서 상대적으로 주석이 필요 없다는 의견도 많은 것 같습니다. 

실제 프로그래밍을 하다보면 6개월에서 1년 정도 지난 후 자신의 소스를 봐도 생소하게 느껴질 것입니다. 

이럴 때 초기에 주석을 달아놨더라면.. 하는 생각을 한번쯤은 해 봤을 겁니다. 

즉, 주석은 다른 사람이 소스를 봤을 때 빨리 이해할 수 있도록 적는 것이 중요합니다. 

가끔 프로그램 소스보다 주석이 많은 경우가 있는데 이는 오히려 가독성을 떨어뜨리는 결과를 가져오기도 합니다. 

그래서 꼭 필요한 부분에 간결하게 적는 습관을 들이는 것이 중요하다고 생각하네요. 

주석으로 문서화를 ~

또한, Javadoc이나 Doxygen과 같은 툴을 활용하면 주석을 그대로 개발 문서로 변경할 수도 있습니다. 

이를 위해 체계적으로 주석을 설정하는 방법도 팀 내부에서는 고민을 해 볼 필요도 있겠지요. 

예를 들면, Javadoc을 통해서 컴파일하면 java api와 같은 형태의 HTML 문서를 생성해 주게 됩니다. 

package kr.co.acronym; /** * String 에 관련된 Util 클래스 * @version : 1.0 * @author : Mini */ public class StringUtils { /** * 문자를 치환하는 Static 함수 * @param str - 문자 * @param pattern 치환 전 문자 * @param replace 치환 후 문자 * @return 성공시 치환 전 문자, 실패시 null */ public static String replace(String str, String pattern, String replace) { return null; } }

이클립스에서 컴파일된 Javadoc을 살펴보면 다음과 같이 나타납니다. 

Javadoc에 대해서는 기회가 되면 다시 한번 정리해 보도록 하죠.. ^^

                 

주석 팁 하나~

마지막으로 간단한 주석의 우선 순위를 활용한 팁을 하나 적어볼께요. 

90년대에 C언어 프로그래밍 할 때 처음 사용했던 방식인데, Java에서도 역시 잘 되더라구요. 

String id; /* id = "test"; /*/ id = request.getParameter("id"); //*/

위와 같이 사용하면 윗 부분이 주석이 되고, 맨 위의 주석의 앞부분에 /를 하나 추가하면 윗 부분이 주석이 됩니다.

위와 같은 Test 계정을 잠시 설정할 때 유용하게 활용했었네요~~