如何在VB.NET中创建文档字符串？

Question

我在Visual Basic中编写.dll.在Visual Studio中编写代码时,如果我执行类似的操作

Console.WriteLine(

它将弹出一个工具提示,其中包含该功能的一些文档.是否有可能在我的function/sub中写一些可以向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块应该加上三个注释(单引号)字符.

您可以在此处查看常用文档XML标记的列表.

好处是,编译器可以提取XML文件并将其与程序集放在一起,文档生成器工具(如Sandcastle,NDoc)可以使用它自动生成带有API文档的格式化帮助文件.