Doxygen

지각생 연습장
  • 소스코드로부터 자동 문서 생성
  • http://www.doxygen.org
  • 문법에 맞게 코드에 주석을 달면, 자동으로 레퍼런스를 생성해준다

doxygen 주석 문법

@ 다음에 문서에 필요한 메타데이터들을 쓴다 (예: @mainpage 메인페이지 제목..)

  • mainpage : 전체 개요 등
  • file : 파일 이름
  • section : 개요 별 설명
  • namespace
  • author
  • date
  • version
  • brief : 간략하 설명
  • details : 자세한 설명
  • param
  • return
  • bug
  • todo
  • see : 참고할 함수나 페이지
  • exception
  • throws
  • code / endcode : 중요코드를 설명할때 시작/종류 지점

참고

개인 도구