C++용 Javadoc과 유사한 문서

C++용 Javadoc과 유사한 문서

---

C++용 Javadoc과 같은 유사한 문서 생성 시스템이 있습니까? Javadoc은 좋은 출력을 생성합니다. 다른 언어에서도 이와 유사한 것을 사용할 수 있다면 좋을 것입니다.

---

C++용 JavaDoc과 같이 작동하는 여러 도구가 있습니다. 가장 인기 있는 도구는 아마도 doxygen 입니다. JavaDoc과 유사한 주석 및 여러 언어(예: C++, C, Java, Objective-C, Python, PHP, C#)를 처리할 수 있습니다. CSS를 사용하여 HTML 출력의 스타일을 조정하는 데 꽤 좋은 지원을 제공합니다( 예제 문서 는 사용자 목록 참조 ).

문서화 시스템을 선택할 때 두 가지 중요한 문제는 문서화 시스템이 다음을 수행할 수 있도록 하는 것입니다.

• 관심 있는 엔터티를 문서화하십시오. 코드 구조를 따르거나 다른 모듈 분할에 따라 시스템을 문서화하시겠습니까?
• 원하는 형식으로 출력을 가져옵니다. 문서가 일반적인 프로젝트 스타일에 맞을 때 선호됩니다.

doxygen에 대한 우리의 경험은 설정 및 사용이 매우 쉽고 결과 출력을 조정하기가 상당히 쉽다는 것입니다. 불행히도, doxygen은 완벽하지 않으므로 어떤 경우에는 doxygen 파서가 고장나는 단점이나 버그를 해결해야 합니다. 생성된 모든 문서를 주의 깊게 검사해야 합니다.

---

특별히 javadoc을 사용할 수는 없지만 원하는 작업을 수행하는 몇 가지 도구가 있습니다. 대부분의 사람들이 사용하는 경향이 있는 것은 Doxygen입니다. 다음은 Doxygen 및 Doc++에 대한 몇 가지 링크입니다.

독시젠
독++

---

많은 것을 지원하는 doxygen이 있습니다. Doxygen

---

QT 기반 C++ 프로젝트를 위한 qdoc도 있습니다. http://doc-snapshot.qt-project.org/qdoc

---

저는 이제 막 Python 프로젝트에 Sphinx 를 사용하기 시작 했습니다. 홈 페이지에는 "C/C++도 이미 지원됩니다"라고 나와 있습니다.

" reStructuredText " 라는 가벼운 마크업을 사용합니다 .

방금 Python 프로젝트에 사용하기 시작했으며 출력 모양이 매우 마음에 듭니다.

ReferenceURL : https://stackoverflow.com/questions/1141228/javadoc-like-documentation-for-c