C# 如何在摘要上添加鼠标
我几乎可以肯定这将是一个非常简单的答案,但我似乎在任何地方都找不到。我们都知道,当您将鼠标悬停在某个对象(如字符串)上时,会弹出一个小摘要(如果已启用)。对于字符串,它表示: 类系统。字符串 将文本表示为一系列Unicode字符 当我将鼠标移到我的一个类上时,它只会说: 类Namespace.Widget 我尝试了我发现的两个明显的例子:C# 如何在摘要上添加鼠标,c#,visual-studio,mouseover,summary,C#,Visual Studio,Mouseover,Summary,我几乎可以肯定这将是一个非常简单的答案,但我似乎在任何地方都找不到。我们都知道,当您将鼠标悬停在某个对象(如字符串)上时,会弹出一个小摘要(如果已启用)。对于字符串,它表示: 类系统。字符串 将文本表示为一系列Unicode字符 当我将鼠标移到我的一个类上时,它只会说: 类Namespace.Widget 我尝试了我发现的两个明显的例子: /// <summary> /// This summary does not work, I know it's for html docume
/// <summary>
/// This summary does not work, I know it's for html documenting tools but thought it was worth a shot.
/// </summary>
那么,如何将摘要添加到鼠标悬停的弹出窗口中呢?在visual studio中重置您的设置,它们似乎乱七八糟。要显示它,您必须使用第一个示例。我不明白为什么您的第一次尝试不起作用。这是
注释标签,它提供了您正在谈论的“工具提示”
/// <summary>
/// This text should automatically show up as the summary when hovering over
/// an instance of this class in VS
/// </summary>
public class MyClass
{
public MyClass() {}
}
public class MyClass2
{
public MyClass()
{
//hovering over 'something' below in VS should provide the summary tooltip...
MyClass something = new MyClass();
}
}
//
///当鼠标悬停在上方时,此文本应自动显示为摘要
///VS中该类的实例
///
公共类MyClass
{
公共MyClass(){}
}
公共类MyClass2
{
公共MyClass()
{
//将鼠标悬停在VS中下面的“某物”上应提供摘要工具提示。。。
MyClass something=新的MyClass();
}
}
如果你想让你的评论自动化,试试免费的。到目前为止,这是最好的免费VS插件之一。三个斜杠XML注释可用于在Visual Studio中创建IDE工具提示。特别是,“总结”和“例外”效果非常好。(在我使用的Visual Studio版本中,像“代码”这样的其他东西不起作用。)
如果这对您不起作用,那么您的设置可能有问题。您需要使用第一个语法,如果您在Visual Studio解决方案之外使用该类,您需要在“项目属性”中选中“生成XML文档文件”。要检查我刚刚发现的两个附加项将阻止在悬停时显示摘要:
请勿使用符号(
&
)或起始尖括号(除了上面的答案,请访问以获取标签的完整列表,为您的类做一个非常漂亮的摘要。我刚刚使用了您的第一个示例,它成功了。是的,我刚刚让它成功了。我正在将我创建的各种类合并到一个名称空间下的一个库中,并且我使用了来自名称的类我没有把总结放进去。我也没有安装ctrl-f崩溃错误的修补程序,因为我担心它会弄乱我计算机上的其他东西。这可能与此相关吗?不起作用,但得到了。哦,这是装饰性的和外围的。如果设置了异常元素的cref
属性,那么EXEC选项将在工具提示中列出。遗憾的是,元素内容被忽略。因此,假设它只起了一半作用。:-)
/// <summary>
/// This text should automatically show up as the summary when hovering over
/// an instance of this class in VS
/// </summary>
public class MyClass
{
public MyClass() {}
}
public class MyClass2
{
public MyClass()
{
//hovering over 'something' below in VS should provide the summary tooltip...
MyClass something = new MyClass();
}
}
///<summary>
///Class does this & that
///</summary>
///<summary>
///Class does this AND that
///</summary>
/// <summary>
/// Checks if this < that
/// </summary>
/// <summary>
/// Checks if this > that
/// </summary>
/// <summary>
/// This text will not show
/// </summary>
/// <summary>
/// This text will also not show
// - This line only has 2 dashes
/// </summary>
/// <summary>
///
/// This
///
/// is fine.
///
/// </summary>