2012-11-25 3 views
2

VS2010의 VB.NET 프로젝트에서 클래스 필드에 XML 주석 ('' ')을 추가하려고합니다. 댓글을 표시하는 데 문제가 있습니다. Main() 하위의 멤버 이름 위에 마우스 커서를 올렸을 때 클래스 메서드에 대한 전체 설명 만 표시됩니다.VS2010 VB.NET XML 클래스 필드에 대한 설명이 표시되지 않습니다.

프로젝트 컴파일 옵션에서 "XML 문서 파일 생성"확인란이 켜져 있습니다. 전체 주석은 보통 Intellisense 목록에 표시됩니다 (오브젝트 이름 다음에 마침표를 입력 할 때).

디자인에 의한 것이거나 환경 설정에서 변경할 수 있습니까?

enter image description here

최소한의 코드 샘플은 아래에 배치했다.

''' <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 
+0

질문이 명확하지 않습니다. 모든 것이 예상대로 작동합니다. 무엇이 문제입니까? – Neolisk

+0

문제를 명확히하기 위해 이미지를 첨부했습니다. – apdevelop

답변

1

당신이 분야에 마우스를 가져 가면 그 XML 주석이 표시되지 않습니다 나타납니다. 이에

Public s As String 

을 변경하는 경우 :

Public Property s As String 

이 작동합니다. 일반적으로 변수를 직접 Public을 통해 노출시키지 말고 대신 속성을 사용하십시오. 이런 방식으로 .NET에 더 잘 통합 될 것입니다 (예 : DataBinding). 참고로

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

그래,이게 내가 정확히 발견 한거야. 나는 하나의 VB.NET 프로젝트 (광산이 아님)를 지원하고 코멘트를 추가하는 것부터 시작하여 코드를 정리하기 시작했다. VB.NET의이 동작은 "설계 상"인 것 같지만 완전히 명확하지는 않습니다. 변수를 프로퍼티로 변경하는 것에 대해 생각할 것입니다. – apdevelop

0

:이 문제가 VB 특정처럼 C#을 대응은 문제없이 작동하기 때문에

는 보이는 VS 2012에서 수정; VB.Net은 지금 필드에 대한 요약을 보여줍니다.

관련 문제