QT CreatorはDoxygen仕様コメントを使用

QT CreatorはDoxygen仕様コメントを使用
転載する場合は出典を明記してください.http://blog.csdn.net/itas109QQ技術交流群:129518033
文書ディレクトリ

QT Creator Doxygen仕様注釈

を使用

前言

1.Doxygen概要

2.QT Creator Doxygenプラグイン

2.1 qtcreator-doxygen概要

2.2 qtcreator-doxygenプラグインインストール

2.3起動カード

2.4 qtcreator-doxygenの使い方

2.4.1直接生成コメント(推奨)

2.4.2右クリック生成コメント(推奨しない)

環境:QT Creator:4.0.3 VS : 2013 update 5 OS : Windows 7 64bit
前言
コードドキュメントは開発プロセスにとって非常に重要であり、ここではDoxygenを用いてコードドキュメントを生成し、関数の説明、クラスライブラリの論理関係、検索などの機能を示すことができ、チーム内部の協同と効率を極めて向上させることができる.
1.Doxygenの概要
Doxygenは、注釈付きC++ソースからドキュメントを生成するための実際の標準ツールですが、C、Objective-C、C#、PHP、Java、Python、IDL(Corba、Microsoft、UNO/OpenOfficeスタイル)、Fortran、VHDL、Tclなどの他のポピュラーなプログラミング言語もサポートしています.
doxygenダウンロードアドレス
2.QT Creator Doxygenプラグイン
2.1 qtcreator-doxygen概要
qtcreator-doxygenはQt CreatorのDoxygenプラグインで、doxygen標準の注釈を実現できます.
qtcreator-doxygen Github
qtcreator-doxygenプラグインダウンロードアドレス

    ：
     Qt Creator     ，  QT Creator 4.0.3        v0.4.4 for Qt Creator 4.0.x/4.1.x

2.2 qtcreator-doxygenプラグインのインストール
該当するプラグインを実行パスに配置すればよい

Unix: ~/.local/share/data/QtProject/qtcreator/plugins
OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins
Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins

2.3プラグインの起動
ヘルプ-プラグインについて-C++-Doxygen-load(true)-Qt Creatorを再起動


2.4 qtcreator-doxygenの使い方
2.4.1コメントを直接生成(推奨)
メソッド:クラス、関数、変数の1行に/**[Enter]を入力

    /**[Enter]
    int a;

    /**[Enter]
    void close();

入力後に関連コメントを自動的に生成

    /**
     * @brief a
     */
    int a;

    /**
     * @brief close
     */
    void close();

2.4.2右クリックでコメントを生成(推奨しない)
必要な行を右クリックして「Document current entity」オプションを選択すると、上記のセクションの注釈が完全で実用的ではないことに注意するコメントが生成されます.
右クリック終了後の結果

int a; /**< TODO: describe */

/**
 * @brief 
 *
 */
void close();

Reference: null
文章はあなたに役に立つと思います.QRコードをスキャンしてブロガーに寄付することができます.ありがとうございます.転載する場合は出典を明記してください.http://blog.csdn.net/itas109QQ技術交流群:129518033