如何在VB.NET中創建文檔字符串？

Question

我在Visual Basic中編寫了一個.dll文件。當在Visual Studio編寫代碼，如果我這樣做

Console.WriteLine(

它會彈出一個提示有位文件的功能。是否有可能在我的函數/子文件中寫入將向Visual Studio提供該信息的內容？

謝謝

Answer 1

是的，當然！喜歡的東西：

''' <summary> 
''' Comment for method 
''' </summary> 
''' <param name="Parameter">Comment for the parameter "Parameter"</param> 
''' <remarks></remarks> 
Sub Test(ByVal Parameter As Integer) 

End Sub 

的XML documentatin塊應該有三個評論（單引號）字符前綴。

您可以查看common documentation XML tags here的列表。

值得一提的是，編譯器可以提取一個XML文件，並將其與您的程序集一起放置，其中文檔生成器工具（如Sandcastle，NDoc）可以自動使用您的API文檔生成帶格式的幫助文件。