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