왼손잡이해방연대 아지트

사용자 확인중...

일지 136호의 개정판

본문 보기

코드에 주석 달기

이번 학기에 시스템 프로그래밍과 컴파일러를 들으면서 주석을 잘 달면 아주 편해진다는 사실을 배웠습니다. (두 수업은 가르치는 교수님이 같으십니다.) doxygen이라는 걸 쓰면 함수마다 모든 파라미터와 리턴 값에 대해 주석을 달 수 있습니다. 주로 C와 C++로 된 스켈레톤 코드를 받아보면 주석이 엄청나게 달려있어 doxygen으로 빌드하면 각 함수의 동작을 웹페이지를 통해 읽어볼 수 있게 됩니다. (가끔 좀 더 설명이 필요할 것 같은데 아무 의미 없는 주석도 달려있긴 합니다.) 그렇게 모든 것에 주석을 다는 일이 바보 같다고 생각하고 함수 이름이나 잘 지으면 된다고 생각했는데, 주석이 달려있는 함수가 생각보다 훨씬 읽고 사용하기가 편했습니다. 앞으로는 저도 가능하면 함수에 주석을 잘 달아봐야겠다고 생각하게 되었습니다. 요즘은 동아리에서 세미나를 진행하면서 수강생들의 과제 코드를 읽어보고 있는데, 함수에 아주아주 상세한 주석이 달려있으면 너무 좋겠다는 생각을 합니다.