在Visual Studio 08中悬停鼠标时显示功能信息

时间:2012-10-03 14:55:43

标签: c++ visual-studio-2008 function mouse

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

类似

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

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

因此,当我在一个大型项目中使用这些函数时,我不需要去寻找那个特定函数或者该变量含义是什么

2 个答案:

答案 0 :(得分:4)

如果你想到像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文档,可用于生成帮助文档。

答案 1 :(得分:2)

您可能需要查看this documentation