类函数中的智能感知注释

Intellisense comments inside class functions?

本文关键字：感知 注释 智能 类函数      更新时间：2023-10-16
在

Visual Studio中的类函数中使用时，有没有办法使C++智能感知注释出现在类成员/函数列表中？我举个例子。

假设我们有一个狗和猫类，如下所示。假设 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 函数的智能感知摘要和返回注释将正常显示。

但是，当在 Dog 的吠叫函数中键入 isBarking 函数（或将鼠标悬停在其上）时，不会显示 isBarking 函数的智能感知摘要和返回注释。有没有办法让它显示？

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

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

相关文章：