2010-02-17 69 views
6

我几乎可以肯定这将是一个非常简单的答案,但我似乎无法在任何地方找到它。我们都知道,当你将鼠标悬停在某个东西上(比如一个字符串)时,会弹出一个小小的摘要(如果它启用的话)。对于一个字符串,它说:如何添加鼠标悬停总结

类System.String

表示文本为一系列的Unicode字符。

当我鼠标移到类之一,它只是说:

类Namespace.Widget

我试过两个明显的例子,我发现:

/// <summary> 
/// This summary does not work, I know it's for html documenting tools but thought it was worth a shot. 
/// </summary> 

和:

// Summary: 
//  This is what is in some of the base libraries, and does not work as well. 

那么,如何添加一个汇总到鼠标悬停弹出?

+0

我刚刚使用你的第一个例子,它的工作。 – Joel

+0

是的,我刚刚得到它的工作。我在结合不同类别,我下一个命名空间做成一个库,我用的是从命名空间中的类我没有把在总结的过程。 –

回答

5

我不明白为什么你的第一次尝试是行不通的。这是<summary>注释标记它提供的“提示”你在谈论...

/// <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(); 
    } 
} 

如果你想帮助自动化你的一些评论中,尝试免费GhostDoc。到目前为止一个最好的免费插件VS ..的

0

重置在Visual Studio中的设置,他们似乎搞砸了。要显示出来,你必须使用第一个例子。

+0

我还没有安装用于CTRL-F的修补程序因为担心它会在我的电脑上搞乱其他东西而导致崩溃。这可能与此有关吗? –

+0

我会怀疑它。 – Malfist

1

三斜杠XML注释可用于创建Visual Studio中的IDE工具提示。特别是,“总结”和“例外”工作得很好。如果这不是你的工作(如“代码”其他的事情还没有,我已经使用的Visual Studio版本的工作。)

,那么就有可能是错的您的设置。

+0

不起作用,但得到了

。哦,这是化妆品和外围设备。 –

+0

如果''的元件exception'的cref'属性被设置,则该异常会在工具提示中列出。可悲的是,元素内容被忽略。所以我们假设它有一半是有效的。 :-) –

0

您需要使用您的第一个语法,而且,如果您使用的Visual Studio解决方案外的类,你需要检查生成项目属性的XML文档文件。