Как включить XML-документы для библиотеки классов в пакет NuGet?

104

Я создаю пакет NuGet для библиотеки классов C #, и я хотел бы включить сгенерированную документацию Xml в библиотеку. Это мой файл NUSPEC:

<?xml version="1.0" encoding="utf-8"?>
<package>
  <metadata>
    <id>MyLibrary</id>
    <version>1.0.0.0</version>
    <authors>John Nelson</authors>
    <language>en-US</language>
    <description>A C# class library</description>
  </metadata>
  <files>
    <file src="..\..\build\MyLibrary.dll" target="lib\Net40" />
    <file src="..\..\build\MyLibrary.xml" target="lib\Net40" />
  </files>
</package>

Когда я создаю пакет с помощью этой команды :

nuget pack MyLibrary.nuspec

Выдает ошибку. Если я удалю строку:

<file src="..\..\build\MyLibrary.xml" target="lib\Net40" />

NuGet.exe успешно создает файл nupkg. Я даже могу разархивировать пакет и проверить правильность содержимого. Что я делаю не так? Должен ли XML-файл перейти в другой целевой каталог?

c# nuget nuget-package Джон Нельсон
источник
Какую команду вы используете для сборки пакета?
Полковник Паник
@ColonelPanic обновил вопрос с командой и ссылкой на документы.
Джон Нельсон
Спасибо, Джон. Я упаковываю csproj напрямую nuget pack library.csproj(у меня нет nuspec), но исправление работает так же.
Полковник Паник

Ответы:

99

Проблема заключалась в том, что я не проверял «Создать XML-документацию» для конфигурации сборки, которую я использовал. Этот Nuspec правильный.

введите описание изображения здесь

Джон Нельсон
источник
6
Хорошо знать. Я пытался использовать графический интерфейс для создания пакета, и он пытался заставить меня переместить XML-файл в папку содержимого вместо библиотеки. Это казалось неправильным, поэтому я хотел узнать второе мнение. Рад, что у вас есть этот пост. :-)
Mike Loux
12

В .NET Core / Standard вы можете сделать это, отредактировав XML-файл проекта, например:

<PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

<PropertyGroup>
    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>

Это выведет документацию в виде файла XML рядом с вашей выходной сборкой.

РЕДАКТИРОВАТЬ: В качестве примечания, как только вы включите, GenerateDocumentationFileвы, вероятно, получите множество предупреждений о своих общедоступных методах за то, что не добавили полные теги документации. Если вы хотите отключить эти предупреждения, просто добавьте PropertyGroup:

<NoWarn>$(NoWarn);1591</NoWarn>
bytedev
источник
<GenerateDocumentationFile>приводит к <DocumentationFile>уже, поэтому я думаю, что требуется только один из них, см .: docs.microsoft.com/en-us/dotnet/csharp/codedoc
Kapé
Если <DocumentationFile>вы укажете себя, вы просто сможете выводить файл куда угодно. Если вы не укажете его, я думаю, он буквально помещает его в путь, который я указал выше.
bytedev