如何将描述添加到函数和函数参数?
我正在写一个VB.NET函数,有大量的重载。 我已经看到,大多数.NET函数在IntelliSense中都有参数描述。 例如,在String.Compare(
input时,IntelliSense表示Compares two specified System.String objects and returns...
你会得到这个想法,这个描述会改变,你点击相同函数的不同的重载版本。一些参数,它描述了你当前input的参数,例如: strA: The first string to compare.
。
我怎样才能对我的职能给予这样的描述?
你所要做的就是在你的函数之前的关键三个撇号。 .NET会为你添加剩下的代码。 将您想要在智能感知中显示的文本插入到标签中。
''' <summary> ''' Returns the name of the code. ''' </summary> Function GetName() As String Return "Something" End Function
对于参数…
''' <summary> ''' Procedure description ''' </summary> ''' <param name="someVariable">someVariable description.</param> ''' <param name="someVariable">someVariable description.</param> ''' <remarks></remarks>
右键单击一个方法/成员名称,然后从上下文菜单中select“插入注释”。
成员/方法的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)
使用xml注释。 在编译之后,会有一些预定义标签加载到智能感知中。 好的是,如果你把光标放在函数上面的那行,然后按'''(如果有意义的话就是三重单引号),然后进入,它会为你预先填充一堆东西。 这里有一篇文章:
用XML注释logging你的代码
将光标放在方法前面的行上,键入三个撇号( '''
)。 您将获得一个用于编写该方法的XML文档的模板以及它的参数。