GPGAのやる気を持続する開発および、研究日記

2007-01-26

[]ヘルプファイルの作り方 第二回「doxygen基本書式」 13:59

私が使用している doxygen の基本的な書き方を説明します。


開始は

/*! もしくは /**

と記述し、終端は

*/

と記述します。


次に各コマンドについて説明します。

コマンドは、コマンド名の最初に「@」か「\」をつけることで

コマンドとして認識します。

私は @派 なので各コマンドの説明は@マークを使用します。

@file   ファイルに対して使用します。
@brief  簡易記述として使うことのできるパラグラフを開始します。
@param  関数引数についての説明を開始します。
@return 関数戻り値についての記述を開始します。
@b      強調表示を行います。

次に、実際に一つのヘッダーファイルをdoxygen形式にした場合の例を記述します。

/*!
 * @file
 * 
 * @brief テストクラスを提供します。
 */
#ifndef INCLUDE_CTEST_H
#define INCLUDE_CTEST_H

/*!
 * @brief テストクラスです。
 */
class CTest
{
public :
    /*!
     * @brief コンストラクタ
     *
     * @param なし
     */
    CTest();
    /*!
     * @brief デストラクタ
     */
    ~CTest();
    /*!
     * @brief 値を加算し、その合計を返します。
     *
     * @param val1 値1を指定します。
     * @param val2 値2を指定します。
     *
     * @return @b val1 と @b val2 の合計を返します。
     */
    int Sum(int val1, int val2);
};

#endif // INCLUDE_CTEST_H

melt_slincmelt_slinc 2007/01/26 14:13 引数には @a を使うのが基本。

GPGAGPGA 2007/02/28 17:12 左様であったか。
ってか、コメントが書かれていたのに今頃気づいた

2007-01-22

[]ヘルプファイルの作り方 第一回「ダウンロード11:29

doxygen」でソースファイルをHTMLヘルプ化し

「ヘルプましん」で読みやすくするライブラリのヘルプファイルの作り方を解説します。



以下からダウンロードしてください。

ヘルプましんを使用するには、Microsoftの「HTML HELP」も必要になりますので

まとめてダウンロードしてください。


doxygen

http://www.doxygen.jp/

右に「ダウンロード」のリンク先からダウンロードする。


HTML HELP

http://www.microsoft.com/japan/office/ork/appndx/appa06.mspx

htmlhelp.exe」のリンクからダウンロードする。


★ ヘルプましん

http://homepage3.nifty.com/KaeruMachine/

メニューの「フリーソフト」のリンク先からダウンロードする。