如何在函数和函数参数中添加描述？答案

【问题标题】：How to add description to functions and function parameters?如何在函数和函数参数中添加描述？
【发布时间】：2011-08-08 17:02:19
【问题描述】：

我正在编写一个带有大量重载的 VB.NET 函数。我已经看到大多数 .NET 函数在 IntelliSense 中都有参数描述。例如，当输入 String.Compare( 时，IntelliSense 会说 Compares two specified System.String objects and returns... 你明白了。此描述会发生变化，您可以单击相同功能的不同重载版本。当您开始为参数输入内容时，它也描述了您当前正在输入的参数。示例：strA: The first string to compare.。

我怎样才能对我的函数进行这样的描述？

【问题讨论】：

标签： vb.net user-defined-functions

【解决方案1】：

您所要做的就是在函数之前的一行中键入三个撇号。 .NET 将为您添加其余代码。在标签中插入要在智能感知中显示的文本。

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function

【讨论】：

【解决方案2】：

对于参数...

''' <summary>
''' Procedure description
''' </summary>
''' <param name="someVariable">someVariable description.</param>
''' <param name="someVariable">someVariable description.</param>
''' <remarks></remarks>

【讨论】：

【解决方案3】：

右键单击方法/成员名称，然后从上下文菜单中选择“插入注释”。

成员/方法的 XML 内容将显示在某些版本的 Visual Studio 中，在智能提示窗口内。

    ''' <summary>
    ''' Summary for the method goes here
    ''' </summary>
    ''' <param name="value">Param comments go here</param>
    ''' <remarks></remarks>
Private Sub SomeMethod(ByVal value As Decimal)

【讨论】：

【解决方案4】：

使用 xml cmets。编译后有一些预定义的标签会加载到智能感知中。奇妙的是，如果您将光标放在函数上方的行上，然后按“”（三单引号，如果有意义的话）并输入，它将为您预填充一堆东西。这是一篇文章：

Documenting Your Code with XML Comments

【讨论】：

【解决方案5】：

将光标放在方法前的行上并键入三个撇号 (''')。您将获得一个模板，用于为该方法及其参数编写 XML 文档。

【讨论】：