c++ - 如何在 VS 2010 Ultimate 中编写和显示 C++ 参数信息？

Question

我一直在关注 C++ 教程，为了方便起见，我想评论一些参数和方法，以便在我将鼠标悬停在它们上时显示它们的相关评论（我相信使用 Intellisense）。我知道如何在 C# 中做到这一点，但无法在 C++ 中弄清楚。

在 Visual C# 2010 express 中，我可以执行以下操作：

键入“///”，自动创建摘要和参数标记。填写我可以创建的评论：

/// <summary>
/// Constructor.
/// </summary>
/// <param name="value_Initial">Initial value.</param>
public DataObject_Float(float value_Initial){
...
}

这样将鼠标悬停在它们上就会显示它们的参数和方法信息。我能得到的最接近的是：

// Constructor.
// value_Initial = Initial value

这并不理想。

我如何在 C++ 中的 VS Ultimate 2010 中执行/模拟此行为，即使我必须手动输入标签、变量名等。我一直无法弄清楚/找到它的语法。编译器不使用 CLR，这显然不受 Intellisense 支持。我还安装了 Visual Assist X 的试用版，如果它可以用来帮助解决这个问题。另外，方法和参数的注释应该放在头文件还是.cpp文件中？

Answer 1

The syntax for VC++ doc comments is reasonably documented in two places. One is the recommended tags and the other is the delimiters.

The doc comments will not show up in hover text, but they will show up in when the auto-complete list is up (i.e. that will show the symbol declaration, any doc comments, and the symbol the file is declared in.

I believe you want to put the doc comments in the header as it seems to be picked for the current translation unit only (i.e. meaning if it's the .cpp you'll only see it when you are in that single .cpp file).