doxygen公式マニュアル

doxygen は、プログラマーにとって便利な補助ツールです。プログラムにバッチ コードを簡単に追加できます。C++、C、Java、Objective-C、Python、などの主流のプログラミング言語と互換性があります。エディターが提供するdoxygen中国語 マニュアルには、基礎的な導入、文法スキル、高度なスキルなどが含まれており、すぐに始めることができますので、必要な場合はダウンロードしてください。

基本的な概要

Doxygen はすでに、ANSI エンコードされた chm ディレクトリ ファイル (index.hhc) の生成をサポートしています! Doxygen は通常、英語ドキュメントの生成に使用されます。中国語ドキュメントを生成するには、入力および出力エンコーディング システムを変更する必要があるため、解析方法が変更され、中国語ドキュメントが生成される可能性があります。 . .ただし、Doxygen はコメントから情報を抽出するときに文法解析を実行する必要があることに注意する必要があります。これらの解析は英語に基づいており、このレベルでは中国語をサポートすることは不可能です。

Doxygen は、C++、C、Java、Objective-C、Python、IDL (CORBA および Microsoft フレーバー)、Fortran、VHDL、PHP、C#、および D 言語用のドキュメント ジェネレーターです。ほとんどの Unix 系システムだけでなく、Mac OS X オペレーティング システムや Microsoft Windows 上でも実行できます。 Doxygen の初期バージョンは DOC++ の古いバージョンから一部のコードを借用しており、その後、Doxygen のソース コードは Dimitri van Heesch によって書き直されました。

doxygen マニュアルは 3 部に分かれており、各部には複数の章が含まれています。

最初の部分はユーザーガイドです

1. インストールでは、プラットフォームに doxygen をダウンロード、コンパイル、インストールする方法について説明します。
2. 最初の doxygen ドキュメントを素早く生成する方法から始めましょう。
3. コードのドキュメント。コードをドキュメント化できるいくつかの方法を示します。
4. リスト。リストを作成するいくつかの方法を示します。
5. 組み合わせ。いくつかの作業を組み合わせる方法を示します。
6. 文書に数式を挿入する方法を示す数式が含まれています。
7. グラフとチャート。doxygen によって生成されるチャートとグラフについて説明します。
8. doxygen がマクロ定義を処理する方法の前処理と解析。
9. ドキュメント内のファイル、クラス、メンバーへのリンクを配置する方法を示す自動リンクを生成します。
10. 出力形式。doxygen でサポートされるさまざまな出力形式を生成する方法を示します。
11. 検索。HTML ドキュメント内を検索するいくつかの方法を示します。
12. カスタム出力、doxygen でカスタマイズされた出力を生成する方法を分析します。
13. カスタム コマンド。コメント内でカスタム コマンドを定義および使用する方法を示します。
14. 外部ドキュメントに接続し、doxygen に外部生成ドキュメントへのリンクを作成させる方法を説明します。
15. FAQ、よくある質問への回答。
16. トラブルシューティング。問題が発生した場合に何をすべきかを示します。

2 番目の部分はリファレンス ガイドです

1. 機能。doxygen の機能の概要を示します。
2. doxygen の履歴。開発プロセス中の変更とそれが行ってきたことを dox​​ygen に通知します。
3. doxygen の使用法、doxygen の使用方法を教えてください。
4. doxytag の使用法、doxytag の使用方法を説明します。
5. doxywizard の使い方、doxywizard の使い方を教えてください。
6. Installdox の使用法。タグ ファイルを使用する場合に、生成された installdox スクリプトを dox​​ygen で使用する方法を説明します。
7. 必要なドキュメントを生成するために doxygen を調整する方法を示す設定。
8. 特別なコマンドの単語。文書内で使用できる特別なコマンドの概要を示します。
9. HTML コマンドワード。ドキュメント内で使用できる HTML コマンドの概要を示します。
10. XML コマンド ワード。ドキュメントで使用できる C# スタイルの XML コマンドの概要を説明します。

第 3 部では、doxygen 開発者向けの情報を提供します (省略)

1. doxygen の内部構造。doxygen の内部構造の全体的な概要を示します。
2. Perl モジュールの出力形式。PerlMod の出力の使用方法を示します。
3. 国際化、新しい言語の出力サポートを追加する方法を分析します。