6

関数にコメントを書き込んで、マウスで関数にカーソルを合わせたときに表示されるようにする必要がある形式はどれか疑問に思っています。

何かのようなもの

void myfunct(int a; char b, float c);

This function just messes with the variables with no objective 
but to show people from stack overflow what I mean.
Inputs-> a: does nothing
         b: neither this one
         c: nope

したがって、大きなプロジェクトで関数を使用する場合、その特定の関数が何のためにあるのか、またはその変数の意味が何であるのかを探す必要はありません。

4

1 に答える 1

4

パラメータと関数の説明を表示するC＃やVBのようなものを考えると、MSVCにはそのようなものはありませんが、Microsoftには、ヘルプの生成に使用できる次のようなコードコメント用の特別な形式があります。

/// <summary>
/// summary of variable, function, class or any thing else
/// </summary>
/// <remarks>
/// detailed description of object
/// </remarks>
/// <param name="a">description of a</param>
/// <param name="b">description of b</param>
/// <param name="c">description of c</param>
/// <returns>describe return value of function</returns>

コードをコンパイルすると、ヘルプドキュメントの生成に使用できるXMLドキュメントが生成されます。

于 2012-10-03T15:42:22.273 に答える