类函数内的Intellisense注释?

时间:2014-12-15 10:32:52

标签: c++ visual-studio

在Visual Studio中的类函数中使用C ++时,是否有任何方法可以使C ++ intellisense注释出现在类成员/函数列表中?让我举个例子。

假设我们有像下面这样的Dog和Cat类。让我们假设猫有一只"狗"引用Dog实例。注意已添加到每个成员函数的Xml注释,特别是此示例的isBarking函数。

class Dog
{
    ///<summary>Makes the dog bark.</summary>
    void bark() { if (isBarking()) { /*woof woof*/ } }

    ///<summary>Is the dog barking?</summary>
    ///<return>This dog has no bark, so it always returns false.</return>
    bool isBarking() { return false; }
}

class Cat
{
    ///<summary>Should the cat run?</summary>
    ///<return>Always true if the dog is barking, otherwise false.</return>
    bool run() { return dog.isBarking(); }
}

在Cat的运行功能中输入isBarking功能(或将鼠标悬停在其上)时,isBarking功能的intellisense摘要和返回注释将按正常显示。

但是,在Dog's bark函数中输入isBarking函数(或将鼠标悬停在它上面)时,isBarking函数不会显示intellisense摘要和返回注释。无论如何要让它显示出来吗?

1 个答案:

答案 0 :(得分:0)

Visual Studio从不显示<return>语句,它们仅用于其他目的。当您从代码中提取文档时,会使用<return>。 Visual Studio仅显示<summary>语句。

我刚刚在VS 2013中复制了您的代码,我可以在鼠标悬停时和键入时看到<summary>。 只需检查您的VS设置,转到Visual Studio编辑器,Edit Menu-> Intellisense. To turn on/off Quick Info, Parameter Info, etc.

相关问题