在nuget包中显示评论

Question

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

例如。如果我有方法

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

然后我希望用户能够看到＆＃34;这种方法可以做到这样的＆＃34;当他们输入方法时。

Answer 1

您必须在构建时启用XML文档。

请参阅here

在Project-Properties中，转到Build-Tab并选择Xml-Documentationfile。

看起来与此相似

Answer 2

对于.NET Core和Visual Studio的最新版本，检查“ XML文档文件”将添加一个绝对路径，如discussed here。这似乎是一个错误，并且阻止了NuGet软件包包含文档。

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

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

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

当前无法从Visual Studio UI中执行此操作；在撰写本文时，is still being discussed进行了更改。