[オリジナル] doxygen を使用してプロジェクトのドキュメントやコメントを管理する、doxygen project

[オリジナル] doxygen を使用してプロジェクトのドキュメントやコメントを管理する、doxygen プロジェクト

1. Doxygen アプリケーションのシナリオ:

doxygen を使用すると、現在の主流のプログラミング言語でコメントを管理し、ドキュメントシステムを形成できます。 (C、C++、C#、Objective-C、IDL、Java、VHDL、PHP、Python、Tcl、Fortran などが含まれます)。 Doxygen 公式 Web サイトのアドレス (http://www.doxygen.nl/) 最近、API インターフェイスのメンテナンスにほとんどの時間が費やされています。より重要な側面の 1 つは、作成したインターフェイスによって呼び出し元がどのように理解できるかということです。使い方が一目でわかります。それは社内の無線サーバーとクライアントの連携であっても、外部に公開されたAPIインターフェースであっても同様です。インターフェイスドキュメントを管理するために doxygen と svn フックを組み合わせて数日試してみたところ、これは非常に便利で実用的でした。 doxygen 公式 Web サイト自体は実際に doxygen を使用して実行しています。より具体的な効果を確認したい場合は、http://www.doxygen.nl/ を直接参照してください。

以下に私が作成したレンダリングの一部を掲載します。実際に使用するときは、会社の UI 部門に美化を依頼してください。私はこれを主にイントラネットで使用しています。 UI エクスペリエンスについてはあまりにも詳しくありません:

2. インストール:

doxygen は現在、Windows、Mac OX、Linux などの主流システムを完全にサポートしています。そしてそれは基本的に、現在主流のすべてのプログラミング言語で使用されています。ここでは、ubuntu システムでのソースコードのコンパイルとインストールのプロセスを簡単に紹介します。その他のインストール方法は公式サイトをご覧ください。

3. doxygen 設定ファイルを使用する設定:

doxygen の使用は、設定ファイルの設定であると言えます。つまり、必要なドキュメントを生成するには、設定ファイルを少し設定してからコマンド xxxx/doxygen xxxx.conf を実行するだけです。 (doxygen はここで提供します) 複数の形式のドキュメントの場合、私は主に HTML を使用するため、この HTML 上で Web サービスを構成し、Web 上でドキュメントを使用できます )、doxygen は構成を通じて 200 以上の構成アイテムを提供します。このファイルにはすでに豊富な機能が備わっています。一般的に使用される構成手順をいくつか示します。

コマンド xxx/doxygen -g を使用して、現在のディレクトリにデフォルト設定ファイル doxygen.conf を生成します。デフォルトの設定ファイルを開くと、その中の各設定項目が設定名設定値 🎜 というキーと値の形式になっていることがわかります。ある程度の英語の知識があれば、設定は基本的に問題ありません。
詳しい構成手順については、http://www.stack.nl/~dimitri/doxygen/manual/config.htmlを参照してください。
ABBREVIATE_BRIEF SaliaSes // エイリアス
ALLEXTERNALS //すべての外部ドキュメント
ALPHABETICAL_INDEX //アルファベット順のインデックス
ALWAYS_DETAILED_SEC //詳細説明部分
BINARY_TOC
RCall_Graph //
CASE_SENSE_NAMES //検出された例の名前
CLASS_GRAPH
DOT_PATH _
dot_transparent//ドット変換設定
DOTFILE_DIRS
ENABLE_PREPROCESSING //「前処理」命令を許可します
ENUM_VALUES_PER_LINE //各行の列挙値
ENABLED_SECTIONS // 分割表示を許可する
EXAMPLE_PATH _Example_patterns // ファイル形式 (*.cpp、*.h、*.java など)
EXAMPLE_RECURSIVE OrCollaboration_Graph // 相互関係を呼び出します
COLS_IN_ALPHA_INDEX // アルファベット順のインデックスを列形式で表示します
COMPACT_LATES
//圧縮rtfdocument
//「サブディレクトリ」を作成します
DIRECTORY_GRAPH
DISABLE_INDEX distribute_group_doc
DOT_IMAGE_FORMAT
// 複数の DOT ターゲット
EXCLUDE_PATTERNS // 実行可能ファイル形式 (*.exe、*.dll など)
EXCLUDE_SYMLINKS // 実行可能SYMLINKS
EXPAND_AS_DEFINED expand_only_predef
EXTERNAL_GROUPS
EXTRACT_ALL EXTRACT_LOCAL_CLASSES
EXTRACT_LOCAL_METHODS
EXTRACT_PRIVATE
EXTRACT_STATIC
ファイルパターン FILE_VERSION_FILTER
FILTER_SOURCE_FILES
full_path_names
//自動定義ファイル形式を生成 generate_buglist generate_chi
GENERATE_DEPRECIATELIST //「評価」リストを生成します generate_html
GENERATE_HTMLHELP // HTMLHELP を生成します
generate_legend generate_man
GENERATE_PERLMOD // Perl スクリプトを生成します
generate_tagfile
GENERATE_TESTLIST //テストリストを生成します
GENERATE_TODOLIST // TODOLIST を生成します
GENERATE_TREEVIEW // ツリービュー表示を生成します
generate_xml graphical_hierarchy
have_dot
HHC_LOCATION
//「複合」友達タイプを非表示
//ドキュメントの本文を隠す hide_scope_names Nhide_undoc_classes // 全クラス
NHide_undoc_members // 「Unpayable Archive」のメンバー全員
HIDE_UNDOC_RELATIONS //「アーカイブされていない」関係を非表示
HTML_ALIGN_MEMBERS //HTML ドキュメント内のメンバーの配置 html_footer html_header
html_stylesheet ignore_prefix
// 画像のパス
Include_path DInherit_docs // ドキュメントの継承関係
line_info
//「継承」によって取得されたインラインメンバー
INPUT_FILTER // 許容可能な入力ファイル拡張子の形式設定 (重要)
Internal_docs
JAVADOC_AUTOBRIEF // JAVADOC ツールによって生成されたドキュメントの「自動要約」
latex_batchmode
latex_cmd_name latex_header
latex_hide_indices
latex_output MACRO_EXPANSION
MAKEINDEX_CMD_NAME
man_extension
man_links
man_output MAX_DOT_GRAPH_DEPTH
MAX_DOT_GRAPH_HEIGHT
max_dot_graph_width
MAX_INITIALIZER_LINES //最大初期化行数
MULTILINE_CPP_IS_BRIEF // 複数の CPP ファイルの簡単な説明
MULTILINE_CPP_IS_BRIEF // 複数の CPP ファイルの簡単な説明
OPTIMIZE_OUTPUT_FOR_C //C の最適化設定
OPTIMIZE_OUTPUT_JAVA //JAVAの最適化設定
OUTPUT_DIRECTORY // 出力パスの設定(重要)
OUTPUT_LANGUAGE // 出力言語設定 (重要)
PAPER_TYPE _
PDF_HYPERLINKS // PDF 形式のハイパーリンク設定 (重要)
PERL_PATH PERLMOD_LATEX
perlmod_pretty
//perlmod MAKE ファイルのバージョン PREFIX predefined
PROJECT_NAME PROJECT_NUMBER
静かに
REFERENCED_BY_RELATION //相互参照 (重要)
S References_relation // 相互参照間の関係 RRepeat_brief // 「簡単な説明」を再設定すると、状態が開きます
RTF_HYPERLINKS
RTF_OUTPUT
InSearch_includes // 何を含める必要がありますか (重要) searchengine AShort_names
SHOW_DIRECTORIES // ディレクトリを表示
SHOW_INCLUDE_FILES // 含まれているファイルを表示します (通常は NO、それ以外の場合は大きすぎます)
// ファイルを表示します (一般的に YES)
／ sort_brief_docs
SORT_MEMBER_DOCS // メンバーの簡単な説明
SOURCE_BROWSER
//どのバーコードフォームのコメントを除外します(重要)
// コメントが含まれるヘッダーファイルを除外します (重要)
// どのバーコードパス設定が除外されます
Ztab_sizea // タブ文字のSIZE設定(重要)
TEMPLATE_RELATIONS // テンプレートの関係設定 (重要)
TOC_EXPAND WTreeView_width
uml_look
USE_WINDOWS_ENCODING //Windowsシステムのエンコーディング形式を使用します(重要)
VERBATIM_HEADERS //VERBATIM ヘッダー (ヘッダーファイル)
_Warn_if_doc_error //
//アーカイブされていないファイルの場合に警告を表示します
WARN_NO_PARAMDOC // パラメータなしのドキュメント警告フォーム設定
warnings XML_DTD
XML_OUTPUT
XML_PROGRAMLISTING //XML プログラムリスト (重要) ～
4. doxygenの設定が完了したらコメントを書く doxygen を設定した後は、基本的にコード内のコメントの作成と保守に時間を費やします。 doxygen を使ってドキュメントを管理したいと考えています。その場合、コードのコメントは厳密に必須である必要はありません。リーリー
仕様に従ってコメントを記述した後、ページドキュメントに表示される効果は次のとおりです:
書き方のルールはプロジェクト内で事前に合意しておくことができ、後はそのルールに従って整備するだけで済みます。もちろん、結局のところ人間は人間なので、すべてのコードが期待されるアノテーションルールに従って記述できることを保証することは不可能です。したがって、ログファイルへのパスは doxygen 設定ファイルで指定できます。このログファイルを有効に活用し、対応するスクリプト言語で小さなコードを記述してログファイルを分析し、人道的な方法で Web ページに表示することができます。指定管理者は注釈エラーログを定期的に確認し、誤った注釈内容を直ちに修正します。
5. doxygen のよく使われる機能 doxygen の機能は上で紹介したものよりもはるかに豊富で、これを使用したい人は、doxygen の公式 Web サイトにアクセスして学ぶことができます。この記事の転載は自由ですが、必ず出典を明記してください。