如何爲功能和功能參數添加說明？

我正在寫一個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

如何爲功能和功能參數添加說明？

回答

相關問題