Doxygen : 소프트웨어 소스코드 문서 작성 자동화 - 소개

본 글을 포함하여 몇 편의 글을 통해 소프트웨어 소스코드 관련 문서 작성 자동화에 대한 내용을 소개한다.

 

문서 작성 자동화 환경은 전용 툴을 이용하여 구성할 수 있다. 분야별로 다양한 문서 작성 자동화 툴이 존재하지만, 본 글에서는 C++ 코드에 관련된 문서 작성 자동화 툴인 doxygen을 소개한다. doxygen이 C++ 만 지원하는 것은 아니며, 지원 가능한 언어는 doxygen 공식 홈페이지에서 확인할 수 있다.

 

문서 작성 자동화의 장점은 소프트웨어 코드 작성과 동시에 문서 업데이트도 가능하다는 것이다.

특히 애자일 프로세스에 따라 개발되는 소프트웨어의 경우 수정과 배포가 빈번하게 발생하기 때문에, 이에 맞춰 문서를 지속적으로 업데이트 하기 위해서는 매우 많은 노력이 필요하다.

문서 작성 자동화를 통해, 별도의 문서 업데이트 작업 없이 코드 내 주석 업데이트라는 최소한의 노력으로 문서를 항상 최신 버전으로 유지할 수 있다.

 

doxygen을 이용한 문서 생성 방법은 다음과 같다.

1. 소프트웨어 소스코드를 작성할 때, 주석을 doxygen에서 인식할 수 있는 형식으로 작성한다.
2. doxygen에 해당 소스코드 파일을 로딩하면, doxygen이 소스코드 내 주석을 해석하여 문서로 작성한다.

결론적으로,

우리가 문서화를 위해 기울여야 할 노력은 ① 소스코드 주석을 약속된 형식에 맞게 작성, ② doxygen 실행 정도이다.

이처럼 필요한 노력이 적고 툴 사용 방법 또한 매우 간단하기 때문에, 개발 환경 구성 초기에 이를 적용하기 위한 상호간 합의와 툴 셋업만 완료하면 이후로는 큰 노력 없이 지속적인 문서 관리가 가능하다.

참고

• doxygen 공식 홈페이지

 

---

파트너스 활동을 통해 일정액의 수수료를 제공받을 수 있음