Doxygen

3. 예시 코드

Doxygen은 특수 주석 구문을 사용하여 소스 코드 내에 문서화를 할 수 있다. 일반적인 주석 구문은 `/*` 뒤에 별표(`*`) 또는 느낌표(`!`)를 추가하는 방식이다. 문서의 모든 명령어는 백슬래시(`\`) 또는 앳사인(`@`)으로 시작한다.^[14] C++ 스타일의 한 줄 주석(`//`)도 지원하며, 추가 슬래시(`/`) 또는 느낌표(`!`)를 사용하여 Doxygen 주석으로 처리할 수 있다.^[15]

```cpp

/**

<간단한 한 줄 설명>

<더 긴 설명>

<필요에 따라 여러 줄 또는 단락으로 구성될 수 있음>

@param someParameter 메서드 또는 함수의 입력 또는 출력 매개변수에 대한 설명

@param ...

@return 반환 값에 대한 설명

• /

3. 1. C++ 코드 예시

• @file
• @brief Time 클래스의 헤더 파일.
• @author John Doe
• @version 1.0
• @copyright CC BY-SA 또는 GFDL.
• @sa Wikipedia:Copyrights - Wikipedia
• /

• Time 클래스는 시간의 순간을 나타냅니다.


• @author John Doe
• /

• 시간을 주어진 값으로 설정하는 생성자.


• @param timeMillis 1970년 1월 1일 이후 경과한 밀리초 수.
• /

• 현재 시간을 가져옵니다.


• @return 현재 시간으로 설정된 Time 객체.
• /

• 시간을 주어진 값으로 설정하는 생성자.
• /

• 인라인 방정식 @f$ e^{\pi i}+1 = 0 @f$


• 표시된 방정식: @f[ e^{\pi i}+1 = 0 @f]


• /

4. Doxygen 소스와 개발

Doxygen 소스는 현재 깃허브에서 호스팅되고 있으며, 주 개발자인 디미트리 반 헤스(Dimitri van Heesch)는 "doxygen"이라는 사용자 이름으로 기여하고 있다.<sup>[28][17]</sup> Doxygen은 C++로 작성되었으며, 300,000개 이상의 소스 라인으로 구성되어 있다. 어휘 분석을 위해 표준 도구인 Lex (또는 대체 도구인 Flex)가 약 35,000 라인의 렉스 스크립트를 통해 실행된다. 파싱 도구인 Yacc (또는 대체 도구인 Bison)도 사용되지만, 사소한 작업에만 사용되며, 언어 파싱의 대부분은 네이티브 C++ 코드로 수행된다. 소프트웨어 빌드 프로세스는 CMake를 기반으로 하며 일부 파이썬 스크립트도 포함한다.

5. 고급 기능

Doxygen은 소스 코드 주석에서 문서를 생성하는 강력한 도구이지만, 기본적인 기능 외에도 고급 기능을 활용하면 더욱 유용하고 가독성 높은 문서를 만들 수 있다.

참조

<sub>[1]</sub> 웹사이트 "ANNOUNCE: doxygen 0.1" http://lists.trollte[...] 2011-10-04
<sub>[2]</sub> 웹사이트 Doxygen Manual: Frequently Asked Questions https://www.doxygen.[...]
<sub>[3]</sub> 웹사이트 Get With the Program: DIY tips for adding coding to your analysis arsenal https://www.the-scie[...] The Scientist 2015-11-22
<sub>[4]</sub> 웹사이트 Doxygen http://foss.unh.edu/[...] University of New Hampshire 2015-11-22
<sub>[5]</sub> 웹사이트 Doxygen https://directory.fs[...] 2015-11-22
<sub>[6]</sub> 웹사이트 Documentation https://rosettacode.[...] 2015-11-22
<sub>[7]</sub> 웹사이트 Documentation: C https://rosettacode.[...] 2015-11-22
<sub>[8]</sub> 웹사이트 Documentation: Objective-C https://rosettacode.[...] 2015-11-22
<sub>[9]</sub> 웹사이트 Doxygen::Filter::Perl - A perl code pre-filter for Doxygen - metacpan.org https://metacpan.org[...]
<sub>[10]</sub> 웹사이트 Doxygen Manual: Getting started https://www.doxygen.[...]
<sub>[11]</sub> 웹사이트 Automatic Python API documentation generation tools https://wiki.python.[...] 2015-11-22
<sub>[12]</sub> 웹사이트 doxypypy: A Doxygen filter for Python https://github.com/F[...]
<sub>[13]</sub> 웹사이트 Doxygen Manual: Graphs and diagrams https://www.doxygen.[...]
<sub>[14]</sub> 문서 Doxygen: Special Commands https://www.doxygen.[...]
<sub>[15]</sub> 문서 Doxygen: Documenting the code - §Comment blocks for C-like languages https://www.doxygen.[...]
<sub>[16]</sub> 문서 Doxygen: Documenting the code - §Putting documentation after members https://www.doxygen.[...]
<sub>[17]</sub> 웹사이트 doxygen/doxygen https://github.com/d[...] 2021-06-09
<sub>[18]</sub> 문서 Doxygen Manual: Changelog https://www.doxygen.[...]
<sub>[19]</sub> 문서 GitHub - doxygen/doxygen: Official doxygen git repository https://github.com/d[...]
<sub>[20]</sub> 문서 Doxygen Manual: Special Commands https://www.doxygen.[...]
<sub>[21]</sub> 웹사이트 "ANNOUNCE: doxygen 0.1" http://lists.trollte[...] 2011-10-04
<sub>[22]</sub> 웹인용 Doxygen Manual: Changelog https://www.doxygen.[...]
<sub>[23]</sub> 문서 FAQ: How did doxygen get its name? http://www.doxygen.n[...]
<sub>[24]</sub> 웹인용 Get With the Program: DIY tips for adding coding to your analysis arsenal https://www.the-scie[...] The Scientist 2015-11-22
<sub>[25]</sub> 웹인용 Doxygen http://foss.unh.edu/[...] University of New Hampshire 2015-11-22
<sub>[26]</sub> 웹인용 Doxygen https://directory.fs[...] 2015-11-22
<sub>[27]</sub> 웹인용 Documentation https://rosettacode.[...] 2015-11-22
<sub>[28]</sub> 문서 https://github.com/d[...]