这种类型的文档是通过XML文档注释添加的。当您启用生成XML文档选项进行编译时,会创建一个XML文件,该文件位于DLL旁边,其中包括文档。您可以将其包含在.nuspec
文件中以与库一起分发,并且Visual Studio将自动获取它。
对于您的函数,只需在///
块中包含所需的标记:
/// <summary>
/// Returns "Hello World!"
/// </summary>
/// <remarks>This function is pretty useless, actually.</remarks>
public string HelloWorld()
有一些常见的和推荐的标签可以使用。Visual Studio 应该能够在这些标签上提供一些 Intellisense。
在构建包时,请启用生成 XML 文档选项,并将生成的 XML 文件包含在 nuspec 文件中,如这个问题所述:如何在 NuGet 包中包含类库的 Xml Docs?
GhostDoc
,你就可以通过使用Ctrl+Shift+D
为类中的所有内容添加注释。 - ragerory