c++ - Visual Studio 08 鼠标悬停时的功能信息显示

Question

我只是想知道哪种格式是我必须在函数中编写注释以便在用鼠标悬停在函数上时显示的格式。

就像是

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

所以当我在一个大项目中使用这些函数时，我不需要去寻找那个特定的函数是什么或者那个变量的含义是什么。

Answer 1

如果你想到像 C# 或 VB 这样显示参数和函数描述的东西，MSVC 中没有这样的东西，但微软有一种特殊的代码注释格式，如下所示，你可以使用它来生成帮助：

/// <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 文档，该文档可用于生成帮助文档。