ドキュメントジェネレータの比較

以下の表は、いくつかのドキュメント生成ツールの一般情報と技術情報を比較したものです。詳細については、各製品の記事をご覧ください。脚注に特に記載がない限り、比較はアドオン、拡張機能、外部プログラムを含まない安定版に基づいています。なお、記載されているツールの多くはメンテナンスが終了しています。

一般情報

ジェネレータに関する基本的な一般情報（作成者または会社、ライセンス、価格など）。

名前 クリエイター 入力形式 言語（アルファベット順） OSサポート 最初の公開日 最新の安定バージョン ソフトウェアライセンス
ドック ウォルター・ブライト文章 D Windows、OS X、Linux、BSD 2005年9月19日 DMD 2.078.3 Boost（オープンソース）
ドキュメントツールチェーン ラルフ・D・ミュラー 文章 ジャワ Windows、OS X、Linux、BSD 2018年8月31日 バージョン3.4.2 MITライセンス
ドキュメント！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.16.1 GPL
エピドック エドワード・ローパー 文章 パイソン どれでも 2002年1月— 3.0（2008年） マサチューセッツ工科大学
fpdoc (フリーパスカルドキュメントジェネレーター) セバスチャン・ギュンターとフリーパスカルコア 文章 (オブジェクト)Pascal/Delphi FPCティア1ターゲット 2005 3.2.2 GPLの再利用可能な部分は静的リンクの例外を伴うGPLです
ハドックサイモン・マーロウ文章 ハスケル どれでも 2002 2.15.0 (2014) BSD
ヘッダードキュメントアップル社文章 AppleScript、Bash、Csh、C、C++、Delphi、IDL、Java、JavaScript、MIG、Pascal、Perl、PHP、Python、Ruby、Tcl Unix系 2000年9月— 2013年8月9日（日） APSL
イマジックス 4Dイマジックス株式会社 文章 C、C++、Java Windows、Linux、Unix 1995 7.3 独自の
Javadocサン・マイクロシステムズ文章 ジャワ どれでも 1995 1.6 GPL
JSDocマイケル・マシューズ 文章 JavaScript どれでも 2001年7月— 1.10.2 GPL
JsDoc ツールキットマイケル・マシューズ 文章 JavaScript どれでも 2007年ですか？ 2.0.0 マサチューセッツ工科大学
mkdジャン＝ポール・ルヨ 文章 コメント付き Unix、Linux、Windows 1989 2015 EUPL GPL
MkDocsトム・クリスティ 文章 パイソン どれでも 2014年10月29日 1.5.3 BSD
ナチュラルドキュメントグレッグ・ヴァリュール 文章 コメント付き どれでも 2003年5月26日 2.0.2 GPL
NDocジェイソン・ダイアモンド、ジャン＝クロード・マノーリ、クラル・フェルチ バイナリ C# Windowsのみ 2003/07/27 1.3.1 GPL
pdocアンドリュー・ギャラント 文章 パイソン どれでも 2013 1.0.1 (2021) ライセンス解除（PD）
パールドキュメントラリー・ウォール文章 パール どれでも 1994 5.16.3 芸術的、GPL
phpDocumentorジョシュア・アイコーン 文章 PHP どれでも 2000 3.0.0 1.x はLGPL 、 2 以上は MIT
pydocカ・ピン・イー[ 1 ]文章 パイソン どれでも 2000 Pythonコア パイソン
RDocデイブ・トーマス 文章 C、C++、Ruby どれでも 2001年12月14日 Rubyコア ルビー
ロボドックフランス・スロットーバー 文章 コメント付き どれでも 1995年1月19日 4.99.36 (2015) GPL
砂の城マイクロソフト文章 。ネット Windowsのみ 2008年5月 2.4.10520 (2016) Ms-PL
スフィンクスゲオルク・ブランドル 文章 Ada、C、C++、Chapel、CMake、Fortran、GraphQL、JavaScript、Matlab、PHP、Python、reStructuredText、Ruby、Rust、VB どれでも 2008/03/21 8.2.1 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 マサチューセッツ工科大学
名前 クリエイター 入力形式 言語（アルファベット順） OSサポート 最初の公開日 最新の安定バージョン ソフトウェアライセンス

サポートされている形式

ジェネレータが書き込むことができる出力形式。

ジェネレータ名 HTMLCHMRTFPDFラテックスポストスクリプトマニュアルページドキュメントブックXMLEPUB
ドック はい はい[ a ]いいえ はい[ a ]はい[ a ]はい[ a ]はい[ a ]いいえ はい[ a ]いいえ
ドキュメントツールチェーンはい いいえ いいえ はい いいえ いいえ いいえ はい いいえ はい
ドキュメント！X はい はい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
エピドック はい いいえ いいえ はい 間接的に[ b ]間接的に[ b ]いいえ いいえ いいえ いいえ
fpdocはい ネイティブ はい 間接的に[ b ]間接的に[ b ]はい いいえ いいえ いいえ いいえ
ハドックはい はい いいえ いいえ いいえ いいえ いいえ 部分的 いいえ いいえ
ヘッダードキュメントはい いいえ いいえ いいえ いいえ いいえ はい いいえ はい いいえ
イマジックス 4Dはい いいえ はい いいえ いいえ いいえ いいえ いいえ いいえ いいえ
Javadocはい 間接的に[ c ]間接的に[ c ]間接的に[ c ]間接的に[ c ]間接的に[ c ]間接的に[ c ]間接的に[ c ]間接的に[ c ]いいえ
JSDocはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
JsDoc ツールキットはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ はい+JSON いいえ
MkDocsはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
ナチュラルドキュメントはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
NDocはい はい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
pdocはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
phpDocumentorはい はい（1.xのみ） いいえ はい（1.xのみ） いいえ いいえ いいえ はい（1.xのみ） はい（1.xのみ） いいえ
pydocはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
RDocはい はい[ d ]いいえ いいえ いいえ いいえ 間接的に[ e ]いいえ はい[ d ]いいえ
ロボドックはい 間接的に はい 間接的に[ b ]はい 間接的に[ b ]はい はい いいえ いいえ
砂の城はい はい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
スフィンクスはい はい いいえ 間接的に[ f ]はい いいえ はい いいえ はい はい
ビジュアルエキスパートはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
VSdocman はい はい いいえ はい いいえ いいえ いいえ いいえ はい いいえ
ヤードはい いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ いいえ
ジェネレータ名 HTML CHM RTF PDF ラテックス ポストスクリプト マニュアルページ ドキュメントブック XML EPUB

その他の機能

拡張カスタマイズの可能性 生成された図 生成されたドキュメントのハイライトとリンク 抽出されたパラメータタイプ
ドック マクロ付き
ドキュメントツールチェーンカスタマイズ可能なテーマ、カスタムタスク 多くのダイアグラムプラグイン（plantUML、mermaid、...） 自動および手動の参照、目次、参考文献など。
ドキュメント！X カスタマイズ可能なHTMLベースのテンプレート、カスタムコメントタグ リンクされたグラフィカルオブジェクト関係図 内部リンクと.NET Frameworkドキュメントへのリンク 抽出されリンクされたタイプ
ドキシゲンXSLTを使用 呼び出し元と呼び出し先のグラフ、依存グラフ、継承図、コラボレーション図
エピドック
ハドックはい はい
ヘッダードキュメント個々のページで、ヘッダー、フッター、コードカラーリング、その他のCSSスタイルをカスタマイズできます。プロジェクト全体の目次は、ユーザー定義のテンプレートから生成されます。 宣言内のシンボルへの自動リンク、ディスカッション内のシンボルへの手動リンク機能などを備えた、設定可能な構文の強調表示/色付け。 タグ付きパラメータがコード、XML出力に含まれる解析済みパラメータ、およびDoxygenスタイルのタグファイル（8.7では-Dフラグ）と一致しない場合に警告を発します。-pフラグによる部分的なCプリプロセッササポート。-Dおよび-Uコマンドラインフラグを使用した#if/#ifdefによるドキュメントの挿入制御をサポートします。
イマジックス 4DスタイルシートとCSSでカスタマイズ可能 関数呼び出し、変数セットと読み取り、クラスの継承とインターフェース、ファイルのインクルードとインターフェース、関数内フローチャートのリンクされた階層と依存関係のグラフ すべての階層と依存関係グラフ、メトリクス テーブル、ソース コード スニペット、ソース ファイルを含む、プロジェクト全体で完全に相互リンクされています。 パラメータ型、条件付きコンパイルディレクティブ、マクロ展開を含むソースコードの完全な意味解析
Javadoc
JSDocはい
JsDoc ツールキットはい
mkdあらゆるタイプのコメントに合わせてカスタマイズ可能 コメントの「そのまま」 すべての一般的なドキュメント、参考資料、マニュアル、組織図など。コメントに含まれるバイナリ コードも含まれます。 すべてのコード化されたコメント
MkDocs
ナチュラルドキュメント
NDoc
パールドキュメントPerl プログラミングを通じてジェネレーター クラスを拡張します。 リンクのみ
pdocオーバーライド可能なJinja2テンプレート ソースコードの構文の強調表示、シンボル宣言への自動クロスリンク はい
phpDocumentorSmarty ベースのテンプレート (1.x)、Twig ベースのテンプレート (2+) クラス継承図 生成されたドキュメントとphp.net関数リファレンスへの相互参照 はい
pydoc
RDoc
ロボドック
スフィンクスカスタマイズ可能なテーマ（10種類のファーストパーティ）; Jinjaテンプレート; Pythonプラグイン クラス継承図、graphviz、サードパーティ（例：aafigure、actdiag、Google Chart、gnuplot、mermaid を使用） 自動相互参照（プロジェクト間を含む）、索引、目次、Pygmentsによる構文強調表示 カスタムオブジェクト（関数やクラスなど）
ビジュアルエキスパートドキュメントの内容とスタイルはカスタマイズ可能 クラス継承、呼び出しツリー、依存関係（影響分析） クラス、メソッド、変数、テーブル、列などの間の内部リンク。 すべてのタイプを抽出
VSdocman すべての出力形式の完全なカスタマイズ、MSDNのような出力のテンプレート、カスタムXMLコメントタグ リンクされたグラフィカルクラス図、クラス継承ツリー 内部リンクと.NET Frameworkドキュメントへのリンク 抽出されリンクされたタイプ
ヤードカスタマイズ可能なRubyテンプレート 追加ツールを使用したクラス図 内部クラス/モジュールの相互参照とRubyソースの強調表示

参照

注記

  1. ^ a b c d e f Ddocには、任意のフォーマットを出力できるようにカスタマイズできるマクロシステムがあります。CHM、groff（manページ）、XHTML、XML、LaTeX（PostScriptとPDF）がテストされています。これらは現在、標準の配布パッケージには含まれていません。標準的なHTML出力もマクロを使用して生成され、再定義可能です。
  2. ^ a b c d e f出力形式としては正式にはサポートされていませんが、Epydoc は最終的な PDF ドキュメントを作成するための中間ステップとして LaTeX と PostScript を使用します。
  3. ^ a b c d e f g hサードパーティのドックレット経由。
  4. ^ a b RDoc は現在、Ruby 1.9 Core の一部として提供される RDoc バージョンでのみ、CHM および XML ドキュメント用のジェネレーターを提供しています。
  5. ^ RDoc は、Unix マニュアル ページの Ruby バージョンであるRIのドキュメントを生成します
  6. ^ LaTeX出力からのみ生成

参考文献

「 https://en.wikipedia.org/w/index.php?title=Comparison_of_documentation_generators&oldid=1334197051」より取得