智能感知不显示注释

本文关键字:注释 显示 感知 智能 | 更新日期: 2023-09-27 18:12:54

如果我在VisualStudio2010中输入一些东西,如DataSet1。我得到所有可用的方法和属性的列表(智能感知)。这很好。但如果我在这个列表中选择一个方法或属性,我不会得到它的描述。

例如,如果我有这样的内容:

public class Dummy
{
    /// <summary>
    /// This is a test-method
    /// </summary>
    public string Do { get; set; }
}

的用法是:

Dummy dummy = new Dummy();
dummy.Do = "dummy";

当我键入dummy时。Do我想在智能感知列表中显示属性注释。通常情况下,这是通过一个工具提示来显示的。

如何打开此行为?

智能感知不显示注释

查看"工具>选项>文本编辑器> c#"。

确保在项目属性中的Build选项卡下选中XML文档文件:复选框。当您引用DLL时,Visual Studio将自动添加此文件。

  • 该功能是否适用于String.Length等属性?这有助于确定问题是影响所有属性还是仅影响用户定义的属性。

  • 如果Dummy类实际上是您的项目引用的单独库的一部分,您可能需要包括XML文档文件以及DLL程序集。

  • 您安装了任何Visual Studio扩展吗?一些扩展,包括但不限于ReSharper、Productivity Power Tools和Code Contracts Editor extensions VS2010,会以可能影响此特性的方式修改IntelliSense表示。尝试禁用已安装的任何扩展并重新启动Visual Studio,看看问题是否得到解决。如果该功能重新开始工作,您可以开始缩小问题范围,以找到导致问题的特定扩展。

zsgalusz是正确的-这就是如何打开它。

如果注释仍然没有显示,请确保XML语法(注释)是正确的。VS(据我所知)不识别语法错误,所以很容易犯错误而不注意它。在大多数情况下,只要一个或多个字符出现在错误的地方,就会导致它不能用于该方法/变量/类等。例如:

/// <summary>
/// Adds a Platform Fee to one of the platform-fee dataGridViews.
/// </summary>
/// <param name="customFee">The Platform Fee being added.</param>
/// <param name="platformGroup">
/// DataGridView the Platform Fee is being added to.
/// 0 = existing platform dataGridView.
/// 1 = recommended platform dataGridView.
/// </param>
/// <exception cref=ArgumentException""></exception>

看起来正确吗?除非argummetnexception不在'"'字符内,否则XML无效,并且智能感知不会显示注释

我发现智能感知没有显示我的评论的原因是因为我的评论太长了。试着缩短summary, param, returns等注释,你可能会在后面看到你的注释