如何为功能和功能参数添加说明？

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

我怎样才能给我的功能这样的描述？

来源

2011-04-19 Phonon

所有你需要做的就是在你的函数之前的关键三个撇号。 .NET会为你添加剩下的代码。将您想要在智能感知中显示的文本插入到标签中。

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

来源

2011-04-19 13:51:40

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

来源

2011-04-19 13:52:07 Guffa

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

Documenting Your Code with XML Comments

来源

2011-04-19 13:54:25 rigamonk

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

成员/方法的XML内容将显示在Visual Studio的某些版本中，位于intellisense tip窗口内。

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

来源

2011-04-19 13:57:56 Smudge202

有关参数...

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

来源

2011-04-19 14:14:29 Jack

如何为功能和功能参数添加说明？

回答

相关问题