1

関数の定義に基づいて、doxygen コメントの自動事前構造を生成する Visual Studio C++ 用のツールまたはプラグインはありますか?

ありがとうございました。

この例のようなもの:

/**
 *****************************************************************************************
 *  @brief      
 *
 *  @usage      
 * 
 *  @param      
 *  @param      
 *
 *  @return     
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );
4

1 に答える 1

0

代わりに、パラメーターとインラインで文書化することをお勧めします

int TestAPI2(
    int argument1, /**< does this **/
    int argument2 /**< does that, should never be a prime number, 
                       and I keep wanting to go on and on about it. **/
    );

パラメータを自動的に文書化するツールは、役に立たない文書を作成し、他の誰かがとにかく記入しなければなりません。

WARN_NO_PARAMDOC = YES文書化されていないパラメーターのリストが必要な場合は、doxygen ファイルに設定できます。

とはいえ、意味のないコメントがコメントなしよりも「優れている」というプロセス上の制約がある場合は、Gostdocを試すことができます。

于 2014-01-28T18:50:43.143 に答える