글쓰기는 쉽지 않습니다. 특히 개발자에게 글쓰기는 왠지 하지 않아도 되는 일을 하는 듯한 느낌마저 듭니다. 하지만 글쓰기는 경력이 더해질수록 점점 중요해진다는 것을 염두해 두세요. 이번 글에서는 보고서나 PPT의 글쓰기가 아닌 코드 문서화에 대해 이야기하려고 합니다. 며칠 전에 H사에서 저희들이 납품한 프로그램에 대해서 자체적으로 유지 보수를 하려고 코드 설명서를 보내달라고 요청이 왔습니다. 일반적으로 고객사는 프로그램 설명서는 요청하지만 코드 설명서는 요청하지 않습니다. 아마 자체적으로 프로그램을 유지 보수 하려다 보니 소스에 대한 설명이 필요해서 코드 설명서를 요청한 것으로 보입니다. MSDN과 같은 훌륭한 설명서를 작성하기에는 저희들은 인적,물적 그리고 시간적으로도 여유가 없습니다. 그래도 개발자가 일주일이라는 시간을 투입하여 문서를 작성한 후에 고객사에 전달하였습니다. 이 문서가 소스 파악에 얼마나 도움이 될지는 저로서는 미지수입니다. 얼마나 도움이 될지도 모를 문서를 작성하는데 들어간 일주일이라는 시간이 아깝게 느껴집니다. 코드 설명서는 코드에서 충분히 만들 수 있고 그리고 Doxygen이라는 훌륭한 툴이 있습니다. Doxygen에 대한 설명은 여기 서 확인할 수 있습니다. Doxygen에서 제대로 코드 설명서를 생성하기 위해서는 Doxygen이 인식할 수 있는 형식으로 주석을 달아줘야 합니다. Doxygen 주석 형식은 여기 서 확인하시면 됩니다. Doxygen은 여기 서 다운 받아 설치하면 됩니다. Doxygen을 사용하기 위해서는 우선 환경 설정을 해야 합니다. 환경 설정의 내용은 Doxyfile이라는 파일로 저장됩니다. Doxyfile은 텍스트 파일로 직접 수정할 수도 있고 Doxygen GUI를 통해 수정할 수도 있습니다. Doxygen GUI 화면 자세한 환경 설정은 여기 서 확인하시면 됩니다. 이렇게 생성한 코드 설명서를 로컬에만 둔다면 활용성이 떨어집니다. 코드 설명서를 위...