2

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

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

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

在此处输入图像描述

最小的代码示例放在下面。

''' <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
4

2 回答 2

1

当您将鼠标悬停在字段上时，似乎没有显示 XML 注释。如果你改变

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();
    }
}
于 2012-11-26T14:46:52.887 回答
0

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

于 2013-07-26T15:12:40.247 回答