![doxygen 문서를 작성하는 방법은 무엇입니까? [폐쇄]](https://linux55.com/image/69990/doxygen%20%EB%AC%B8%EC%84%9C%EB%A5%BC%20%EC%9E%91%EC%84%B1%ED%95%98%EB%8A%94%20%EB%B0%A9%EB%B2%95%EC%9D%80%20%EB%AC%B4%EC%97%87%EC%9E%85%EB%8B%88%EA%B9%8C%3F%20%5B%ED%8F%90%EC%87%84%5D.png)
상사가 그것을 사용하라고 하더군요 doxygen. 구글링해서 codesdoxygen으로 문서화를 할 수 있다는 걸 알았습니다. 그런데 코드 세부사항과 텍스트 문서화는 어떻습니까?
답변1
먼저 doxygen을 설치합니다(귀하의 OS 배포판에 패키지가 있을 것입니다). 그런 다음 소스 트리의 최상위 디렉터리에서 다음을 실행합니다.
doxywizard Doxyfile
이는 기본적으로 doxygen을 진행하는 방법에 대한 지침 세트인 Doxyfile을 생성하는 쉬운 방법을 제공합니다. 나는 하위 디렉터리로 출력하도록 구성하고 싶습니다 doc/html.
그런 다음 소스 코드에 doxygen 주석을 추가하세요. 다음을 사용하여 파일 상단에 주석을 달아야 합니다.
//! \file myfile.h This is my header file
그런 다음 개별 기호에 다음과 같이 주석을 답니다.
//! This is my function:
void function();
아래에 언급된 다른 구문이 있습니다. http://www.doxygen.nl/manual/docblocks.html#specialblock
그런 다음 다음을 실행하십시오.
doxygen
문서가 생성됩니다. 웹 브라우저를 시작합니다.
아, 그리고 소스 코드 없이 문서 파일을 원하신다면 문제 없습니다. FILE_PATTERNS에 있는지 .md확인하기 위해 doxygen을 구성할 수 있습니다 . *.mdUSE_MDFILE_AS_MAINPAGE를 Markdown 파일로 설정하여 Markdown에서 홈페이지를 만들 수도 있습니다. 이러한 지침은 Doxyfile에 있지만 마법사에서 편집할 수도 있습니다.