如何在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文档的格式化帮助文件。