VS2010 VB.NET XML 注释类字段未显示

Question

在 VS2010 的 VB.NET 项目中，我尝试将 XML cmets (''') 添加到类的字段中。显示 cmets 存在问题：当我将鼠标光标放在 Main() sub 中的成员名称上时，只显示类方法的完整 cmets。

在项目编译选项中“生成 XML 文档文件”复选框被打开；完整的 cmets 通常显示在智能感知列表中（当我在对象名称后键入句点时）。

这是设计使然还是可以更改偏好？

下面的最小代码示例。

''' <summary>
''' Test class
''' </summary>
''' <remarks></remarks>
Public Class TestClass

    ''' <summary>
    ''' Test field
    ''' </summary>
    ''' <remarks></remarks>
    Public s As String

    ''' <summary>
    ''' Test method
    ''' </summary>
    ''' <remarks></remarks>
    Public Sub Method()

    End Sub

End Class

Sub Main()
    Dim c = New TestClass() ' "Class TestClass \ Test class" displayed
    c.s = "abc"             ' Only "Public s As String" displayed!
    c.Method()              ' "Public s As String \ Test method" displayed
End Sub

Answer 1

当您将鼠标悬停在字段上时，XML cmets 似乎不显示。如果你改变了

Public s As String

到这里：

Public Property s As String

它会起作用的。通常，您不应直接通过Public 公开变量，而应使用属性。您将通过这种方式更好地集成到 .NET（例如 DataBinding）。

看起来这个问题是 VB 特有的，因为 C# 对应的工作没有问题：

/// <summary>
/// Test class
/// </summary>
/// <remarks></remarks>
class TestClass
{
    /// <summary>
    /// Test field
    /// </summary>
    /// <remarks></remarks>
    public String s;

    /// <summary>
    /// Test method
    /// </summary>
    /// <remarks></remarks>
    public void Method() {}

    static void Main(string[] args)
    {
        TestClass c = new TestClass();
        c.s = "abc"; //not a property, but help shows on hover
        c.Method();
    }
}

Answer 2

仅供参考：在 VS 2012 中已修复； VB.Net 现在显示字段摘要。