Doxygen 대 Javadoc
CACM의 기사에서 Doxygen이 Java (및 기타 여러 언어)에서도 작동한다는 사실을 방금 깨달았습니다. 그러나 Java에는 이미 Javadoc 도구가 있습니다. 누군가가 두 접근 방식의 장단점을 설명 할 수 있습니까? 상호 배타적입니까? Doxygen 용 Maven 플러그인이 있습니까?
Doxygen에는 계층 구조 및 협력 컨텍스트에 대한 클래스 다이어그램, 추가 요약 페이지, 선택적 소스 코드 검색 (문서와 교차 링크), @todo on과 같은 추가 태그 지원 등 JavaDoc이 제공하지 않는 여러 기능이 있습니다. 별도의 페이지로 TeX 및 PDF 형식으로 출력을 생성 할 수 있으며 많은 시각적 사용자 정의가 가능합니다.
Doxygen은 표준 JavaDoc 태그를 지원하므로 JavaDoc 주석이있는 모든 소스 코드에서 Doxygen을 실행할 수 있습니다. 다이어그램과 소스 코드 브라우징은 문서 없이도 코드를 이해하는 데 도움이 될 수 있기 때문에 JavaDoc없이 소스 코드에서 실행하는 것이 합리적 일 수 있습니다. 그리고 JavaDoc 도구는 알 수없는 태그를 무시하므로 JavaDoc 생성을 중단하지 않고 추가 Doxygen 태그를 사용할 수도 있습니다.
이 모든 것을 말하면서 나는 오랫동안 Doxygen을 사용하지 않았다는 것을 인정해야합니다. 요즘에는 동일한 시각화를 제공하기 위해 IDE에 크게 의존하는 경향이 있으며 일반적으로 JavaDoc을 HTML 페이지로 읽지 않고 소스 파일을 IDE로 가져 와서 JavaDoc 플라이 아웃을 생성하고 정의로 이동할 수 있습니다. 그것은 Doxygen이 제공하는 것보다 훨씬 더 강력합니다. IDE 외부의 문서를 원하고 비 Java 도구를 실행하는 데 만족한다면 Doxygen은 Java 코드를 변경할 필요가 없기 때문에 시도해 볼 가치가 있습니다.
Java를 처음 사용하고 이전에 Doxygen을 사용한 적이있는 경우에만 Java와 함께 Doxygen을 사용하여 javadoc에서 경험하는 학습 곡선을 줄였습니다. 이전에 Doxygen을 사용하지 않았다면 Java를 염두에두고 특별히 설계되었으므로 javadoc을 고수 할 것입니다. 둘 중 하나를 모르고 Java를 수행하는만큼 C ++ (또는 기타 지원되는 언어)로 작업하는 경우 Doxygen은 두 언어 모두에 사용할 수 있으므로 좋은 선택입니다.
두 도구 모두 유사한 기능 세트로 사용하기 쉽습니다. 둘 다 NetBeans 및 Eclipse 용 플러그인 (또는 미리 내장되어 있음)을 사용하여 문서를 훨씬 빠르게 생성 할 수 있습니다. 각각에 사용되는 주석 스타일에는 겹치는 부분이 많지만 정확히 동일 하지 않으므로 함께 혼합하기가 어려울 수 있습니다 ( 둘 다 세부 사항을 알고 있어야하며 기능은 제외해야합니다. 특정). 나는 그것을 사용한 적이 없지만 Doxygen 용 Maven 플러그인 이있는 것 같습니다 .
Doxygen을 사용하면 문서와 같은 페이지에 클래스 다이어그램을 표시 할 수 있다는 사실이 마음에 듭니다. 또한 필요한 경우 소스 코드에 직접 연결된다는 사실이 마음에 듭니다. 그래도 javadoc에 이러한 기능이 있는지 알 수 없습니다.
JavaDocs의 큰 장점 중 하나는 바로 작동한다는 것입니다. 이를 빌드하고 보는 데 필요한 모든 것은 프로그램 컴파일을 위해 이미 설치해야하는 JDK에 포함되어 있습니다.
반면에 Doxygen은 설정하고 올바르게 작동하는 데 어려움을 겪을 수 있습니다. 그러나 올바르게 설정되면 HTML뿐 아니라 PDF, RTF 및 DocBook을 생성 할 수 있어야합니다. index.html은 기본적으로 빈 페이지를 가져 오므로 HTML은 기본적으로 JavaDocs만큼 잘 구성되지 않습니다. 또한 인라인 클래스와 정적 멤버는 문서에 포함되는 특수 플래그가 필요할 수 있으며 PDF를 생성하려면 필요한 pdflatex 명령이없는 Linux 배포의 번거 로움을 처리해야 할 수 있습니다 (예 : Ubuntu / Mint는 최근에 문제가 있음) 그래서 그냥 apt-get 설치하고 실행하면 간단한 프로그램으로도 오류로 가득 찬 화면이 나타날 수 있습니다. API를 설치할 때 자동으로 javadoc을 얻는 것과 비교하면 Doxygen 설정은 비참한 경험이 될 수 있습니다. 장애물을 극복하면
참고 URL : https://stackoverflow.com/questions/225447/doxygen-vs-javadoc
'development' 카테고리의 다른 글
| Javascript ID로 요소 가져 오기 및 값 설정 (0) | 2020.11.15 |
|---|---|
| 기본 스택 크기는 무엇이며 확장 할 수 있으며 가비지 수집과 어떻게 작동합니까? (0) | 2020.11.15 |
| .exp의 용도는 무엇이며 .lib와 .dll의 차이점은 무엇입니까? (0) | 2020.11.15 |
| C ++ 용 종속성 주입 프레임 워크 (0) | 2020.11.15 |
| Windows 배치 줄 바꿈 변수 해킹이 어떻게 작동하는지 설명 (0) | 2020.11.15 |