문서 생성기 비교

Comparison of documentation generators

다음 표는 다수의 문서 생성기에 대한 일반 정보와 기술 정보를 비교한다.자세한 내용은 개별 제품의 문서를 참조하십시오.각주에 달리 명시되지 않는 한, 비교는 추가 기능, 확장 프로그램 또는 외부 프로그램이 없는 안정적인 버전에 기초한다.나열된 발전기 중 많은 발전기가 더 이상 유지되지 않는다는 점에 유의하십시오.

일반 정보

생성자에 대한 기본적인 일반 정보(작성자 또는 회사, 라이센스 및 가격 포함)

이름 크리에이터 입력 형식 언어(알파벳 순서) OS 지원 첫 공개일 최신 안정화 버전 소프트웨어 라이선스
코볼도크 브루노 파체코 로페스 다 시우바 텍스트 코볼 아무거나 2020/08/01 1.0.11 GPL
Ddoc 월터 브라이트 텍스트 D Windows, OS X, Linux 및 BSD 2005/09/19 DMD 2.078.3 부스트
문서!x 이노바시스 텍스트, 이진 C++/CLI 전용, C#, IDL, Java, VB, VBScript, PL/SQL Windows 전용 1998 2014.1 소유권
독시겐 디미트리 판 히슈 텍스트 C/C++, C#, D, IDL, Fortran, Java, PHP, Python 아무거나 1997/10/26 1.9.1 GPL
에피닥 에드워드 로퍼 텍스트 파이톤 아무거나 2002/01/— 3.0 (2008) MIT
fpdoc(무료 파스칼 문서 생성기) 세바스티안 귄처 텍스트 파스칼 [필요하다] 2005? 2.6.4 GPL
해덕 사이먼 말로우 텍스트 하스켈 아무거나 2002 2.15.0 (2014) BSD
헤더Doc 애플 텍스트 AppleScript, Bash, Csh, C, C++, Delphi, IDL, Java, JavaScript, MIG, Pascal, Perl, PHP, Python, Ruby, Tcl 모든 Unix 유사 2000/09/— 8.9.28 (2013) APSL
이매믹스 4D 이매직스 주식회사 텍스트 C, C++, 자바 Windows, Linux, Unix 1995 7.3 소유권
자바독 선 마이크로시스템스 텍스트 자바 아무거나 1995 1.6 GPL
스칼라닥 램프, EPFL 텍스트 스칼라 아무거나 2011 1.0 스칼라 라이선스
JSDoc 마이클 매튜스 텍스트 자바스크립트 아무거나 2001/07/— 1.10.2 GPL
JsDoc 툴킷 마이클 매튜스 텍스트 자바스크립트 아무거나 2007? 2.0.0 MIT
mkd 장폴 루요트 텍스트 의견이 있는 임의 Unix, Linux, Windows 1989 2015 EUPL GPL
자연 문서 그레그 발레 텍스트 의견이 있는 임의 아무거나 2003/05/26 2.0.2 GPL
NDOC 제이슨 다이아몬드, 장 클로드 마놀리, 크랄 페르치 이진수 C# Windows 전용 2003/07/27 1.3.1 GPL
pdoc 앤드루 갤런트 텍스트 파이톤 아무거나 2013 1.0.1 (2021) 언라이센스
pdoc3 연마하다 텍스트 파이톤 아무거나 2018 0.9.2 (2020) 아페로 GPL
만능의 래리 월 텍스트 아무거나 1994 5.16.3 예술, GPL
phpDocumentor 조슈아 아이혼 텍스트 PHP 아무거나 2000 3.0.0 1.x의 경우 LGPL, 2+의 경우 MIT
피닥 예이[1][2] 카핑 텍스트 파이톤 아무거나 2000 파이톤코어로 파이톤
RDOC 데이브 토머스 텍스트 C, C++, 루비 아무거나 2001/12/14 루비코어로 루비
로보덕 프란스 슬로터우버 텍스트 의견이 있는 임의 아무거나 1995/01/19 4.99.36 (2015) GPL
록시겐2 해들리 위컴 텍스트 R 아무거나 2011/07/23 7.1.2.9000 MIT
러스트닥 러스트 프로젝트 텍스트 아무거나 2020년 9월 1.52.1 Apache 2.0 또는 MIT
샌드캐슬 마이크로소프트 텍스트 .NET Windows 전용 2008/05/— 2014.5.31.0 Ms-PL
Sandcastle 도움말 파일 작성기 에릭 우드러프 텍스트 .NET Windows 전용 2015/01/12 2021.-.-.- Ms-PL
스핑크스 게오르크 브란들 텍스트 Ada, C, C++, Fortran, JavaScript, PHP, Python, Ruby 아무거나 2008/03/21 3.5.4 BSD
비주얼 전문가 노발리스 텍스트, 이진 C#, PL/SQL, Transact-SQL, PowerBuilder Windows 전용 1995 2017 소유권
VSdocman 헬릭스소프트 텍스트 VB, VBScript, C# Windows 전용 2003년 10월 2일 9.0 소유권
야드 로렌 시걸 텍스트 루비 아무거나 2007/02/24 0.7.3 MIT
이름 크리에이터 입력 형식 언어(알파벳 순서) OS 지원 첫 공개일 최신 안정화 버전 소프트웨어 라이선스

지원되는 형식

생성자가 쓸 수 있는 출력 형식.

HTML CHM RTF PDF 라텍스 포스트스크립트 맨 페이지 닥북 XML ePub
코볼도크 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
Ddoc [a] 아니요. [a] [a] [a] [a] 아니요. [a]
문서!x 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
독시겐 간접적으로[b] 간접적으로[b] 아니요.
에피닥 아니요. 아니요. 간접적으로[c] 간접적으로[c] 아니요. 아니요. 아니요.
해덕 아니요. 아니요. 아니요. 아니요. 아니요. 부분적 아니요.
헤더Doc 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
이매믹스 4D 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
자바독 간접적으로[d] 간접적으로[d] 간접적으로[d] 간접적으로[d] 간접적으로[d] 간접적으로[d] 간접적으로[d] 간접적으로[d]
JSDoc 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
JsDoc 툴킷 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 예스+JSON
자연 문서 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
NDOC 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
pdoc 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
pdoc3 아니요. 아니요. 간접적으로[e] 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
phpDocumentor 예(1.x에만 해당) 아니요. 예(1.x에만 해당) 아니요. 아니요. 아니요. 예(1.x에만 해당) 예(1.x에만 해당)
피닥 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
RDOC [f] 아니요. 아니요. 아니요. 아니요. 간접적으로[g] 아니요. [f]
로보덕 간접적으로 간접적으로[c] 간접적으로[c] 아니요.
샌드캐슬 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
스핑크스 간접적으로[h]
비주얼 전문가 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
VSdocman 아니요. 아니요. 아니요. 아니요. 아니요.
야드 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요. 아니요.
HTML CHM RTF PDF 라텍스 포스트스크립트 맨 페이지 닥북 XML ePub

기타 기능

사용자 정의가 확장될 가능성 생성된 다이어그램 생성된 문서의 강조 표시 및 링크 추출된 매개 변수 유형
코볼도크
Ddoc 매크로로
문서!x 사용자 지정 가능한 HTML 기반 템플릿, 사용자 지정 주석 태그 연결된 그래픽 개체 관계 다이어그램 내부 링크 및 에 대한 링크NET Framework 설명서 추출 및 연결된 유형
독시겐 XSLT로 호출자 및 호출자 그래프, 종속성 그래프, 상속 다이어그램, 협업 다이어그램
에피닥
해덕
헤더Doc 개별 페이지의 사용자 정의 헤더, 바닥글, 코드 색상 및 기타 CSS 스타일.프로젝트 전체 TOC는 사용자 정의 템플릿에서 생성된다. 선언에서 기호에 자동 연결, 토론에서 수동으로 기호에 연결하는 기능 등을 사용하여 구성 가능한 구문 강조 표시/색상 태그가 지정된 매개 변수가 코드, XML 출력에 포함된 구문 분석된 매개 변수 및 Doxygen 스타일 태그 파일(-D 플래그 8.7).-p 플래그가 있는 부분 C 전처리기 지원.-D 및 -U 명령줄 플래그를 사용하여 문서 포함에 대한 #if/#ifdef 제어 지원.
이매믹스 4D 스타일 시트 및 CSS를 통해 사용자 정의 가능 함수 호출, 변수 집합 및 읽기, 클래스 상속 및 인터페이스, 파일 포함 및 인터페이스, 인터페이스, 기능 내 흐름도에 대한 연결된 계층 및 종속성 그래프 모든 계층 및 종속성 그래프, 메트릭 테이블, 소스 코드 스니펫 및 소스 파일을 포함하여 프로젝트 전체에 걸쳐 완전히 상호 연결됨 매개변수 유형, 조건부 컴파일 지시서, 매크로 확장을 포함한 소스 코드의 전체 의미 분석
자바독
JSDoc
JsDoc 툴킷
mkd 모든 유형의 주석에 대해 사용자 정의 가능 코멘트로 '있는 그대로' 모든 일반 문서, 참고 자료, 설명서, 오르간그래프, ...코멘트에 포함된 이진 코드 포함. 코딩된 모든 논평
자연 문서
NDOC
만능의 Perl 프로그래밍을 통해 제너레이터 클래스를 확장하십시오. 링크만
pdoc 재정의 가능한 Jinja2 템플릿 소스 코드 구문 강조 표시, 기호 선언에 대한 자동 교차 표시
pdoc3 재정의 가능한 마코 템플릿 소스 코드 구문 강조 표시, 기호 선언에 대한 자동 교차 표시
phpDocumentor Smarty 기반 템플릿(1.x), Twig 기반 템플릿(2+) 계급 상속도 생성된 문서 및 php.net 기능 참조에 대한 상호 참조
피닥
RDOC
로보덕
스핑크스 10가지 테마, Jinja2 템플리트, Python 플러그인 예를 들어 aafigure, actdiag, Google Chart 또는 gnuplot 사용과 같은 스핑크스-controp에서 여러 개. 목차, 색인, 교차 참조, 구문 강조 표시(파열 표시) 사용자 지정 개체(함수 및 클래스 등)
비주얼 전문가 사용자 정의 가능한 문서 내용 및 스타일 클래스 상속, 호출 트리, 종속성(영향 분석) 클래스, 메서드, 변수, 테이블, 열 간의 내부 링크... 추출한 모든 유형
VSdocman 모든 출력 형식에 대한 전체 사용자 지정, MSDN 유사 출력용 템플릿, 사용자 지정 XML 주석 태그 연결된 그래픽 클래스 다이어그램, 클래스 상속 트리 내부 링크 및 에 대한 링크NET Framework 설명서 추출 및 연결된 유형
야드 사용자 정의 가능한 루비 템플릿 여분의 도구로 도표를 분류하다. 내부 클래스/모듈 상호 참조 및 Ruby 소스 강조 표시

누락 가능성

참고 항목

메모들

  1. ^ a b c d e f Ddoc은 원하는 포맷을 출력하도록 사용자 정의할 수 있는 매크로 시스템을 가지고 있다.CHM, 그로프(맨 페이지), XHTML, XML 및 LaTeX(그래서 PostScript 및 PDF)를 테스트했다.그것들은 현재 표준 분포에 포함되어 있지 않다.표준 HTML 출력도 매크로를 사용하여 생성되며 재정의할 수 있다.
  2. ^ a b LaTeX 출력에서만 [3]생성됨
  3. ^ a b c d 출력 형식으로는 공식적으로 지원되지 않지만, Epydoc은 최종 PDF 문서를 작성하기 위한 중간 단계로 LaTeX와 PostScript를 사용한다.
  4. ^ a b c d e f g h 제3자의 도클렛을 통해.
  5. ^ Markdown 또는 HTML 출력에서만 생성됨
  6. ^ a b RDOC는 현재 RDOC 버전에서 RDOC 1.9 Core의 일부로 제공되는 CHM 및 XML 문서용 발전기만 제공한다.
  7. ^ RDoc은 RI에 대한 문서를 생성하는데, 이것은 루비의 유닉스 맨 페이지 버전이다.
  8. ^ LaTeX 출력에서만 생성됨

참조

  1. ^ "Ka-Ping Yee: Curriculum Vitae".
  2. ^ "PEP 256 -- Docstring Processing System Framework Python.org".
  3. ^ "Doxygen Manual: Output Formats". Archived from the original on 2013-01-06.