c# - 在 nuget 包中显示评论

Question

如何在我的 nuget 包中包含我在方法和属性上方写的注释？ IE。因此，当库被使用时，用户可以使用智能感知并阅读该方法的内容？

例如。如果我有方法

/// <summary>
/// This method does such and such
/// </summary>
public void SomeMethod()
{
   // does something..
}

然后我希望用户在键入方法时能够看到“此方法做了这样那样的事情”。

Answer 1

对于 .NET Core 和最新版本的 VisualStudio，选中“XML 文档文件”将添加一个绝对路径，如 discussed here .这似乎是一个错误，它会阻止 NuGet 包包含文档。

解决方案是将以下内容添加到 .csproj 文件，然后取消选中“XML 文档文件”框。

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

目标是 recently added to the SDK因此，如果此值为真，并且 DocumentationFile 为空(即未在 Visual Studio 中设置该复选框)，它将“做正确的事”并在输出文件夹中生成文档文件NuGet 期望的。

目前无法从 Visual Studio UI 执行此操作；进行更改的请求 is still being discussed截至撰写本文时。

更新:现在的设置看起来是 available as a preview feature在 Visual Studio 中。