Question

我不明白vb评论。我读到当某人（或我自己？）正在使用我的代码时，可以在代码完成框中给出提示。但我在视觉工作室找不到东西。你能否简单解释一下如何到达那里。

Answer 1

阅读this MSDN杂志关于代码注释的文章，了解这些注释的工作原理。

而here就是如何。

简单地说，您使用三个'字符和XML注释将它们用作代码注释（'''<summary>Summary of my code</summary>）。

Answer 2

您要问的功能称为“XML文档注释”。 This article从VB.Net的角度讨论它们。来自文章：

Visual Basic的XML注释最初是在Visual Studio 2005中引入的。它们可用于为项目创建文档文件，并为您自己，您的团队成员或使用您的代码的其他人提供丰富的开发环境体验。 / p>

示例：

''' <summary>
''' This function does really cool stuff.
''' </summary>
''' <param name="foo">The foo to work with</param>
''' <returns>True on success, False on error</return>
Public Function CoolThing(ByVal foo As String) As Boolean
' ...
End Function

...但不要担心，您不必自己输入summary，param，returns件事，编辑会帮助您。

Answer 3

这很简单，只需要评论标记的三倍，例如：'''

Answer 4

尝试使用此代码查看其工作原理

Private Sub Button1_Click(ByVal sender As System.Object, _
                          ByVal e As System.EventArgs) Handles Button1.Click

    IllustrateComments() 'fix this statement to see how this works
    Dim foo As Boolean = IllustrateFunctionComment() 'fix

End Sub

' Most of this is Auto Generated by typing three ' 
''' <summary>
''' This is the summary block
''' </summary>
''' <param name="firstParameter">This is a description of the first parameter</param>
''' <param name="secondParameter">This is a description of the optional second parameter</param>
''' <remarks>*** Some remarks ***</remarks>
''' <exception cref="Exception"> *** Exception here ***</exception>

Private Sub IllustrateComments(ByVal firstParameter As String, _
                               Optional ByVal secondParameter As Integer = 0)
    '
    Try

    Catch ex As Exception

    End Try
End Sub

''' <summary>
''' Summarry of the function.  Note the return
''' </summary>
''' <param name="param1">param1 description</param>
''' <returns>returns a boolean - DUH!</returns>
''' <remarks>*** Some remarks - see object browser to see full benefit ***</remarks>
Private Function IllustrateFunctionComment(ByVal param1 As String) As Boolean
    Return True
End Function

我发现这两个链接很有用

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

http://msdn.microsoft.com/en-us/library/ms172653.aspx

完成框中的VB注释

4 个答案: