dotnet-xml-docs

Write and generate XML documentation comments for .NET code.

71|10|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-xml-docs-wshaddix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-xml-docs
Source: https://github.com/wshaddix/dotnet-skills/tree/main/skills/dotnet-xml-docs
Command: npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-xml-docs-wshaddix

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers create high-quality XML documentation comments for their .NET code, improving code clarity, maintainability, and IntelliSense support for consumers.

Core Features & Use Cases

  • Standard & Advanced Tags: Covers all essential XML doc tags (<summary>, <param>, <returns>, <exception>, etc.) and advanced ones like <inheritdoc /> for inheritance.
  • MSBuild Integration: Guides on configuring <GenerateDocumentationFile> to include XML docs in build outputs and NuGet packages.
  • Warning Suppression: Strategies for managing CS1591 warnings for internal APIs.
  • Use Case: Ensure your public NuGet library provides excellent IntelliSense by documenting all public members correctly, making it easy for other developers to understand and use your API.

Quick Start

Configure your .csproj file to generate XML documentation files by adding <GenerateDocumentationFile>true</GenerateDocumentationFile> to your <PropertyGroup>.

Frequently Asked Questions about dotnet-xml-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate XML documentation files for a .NET project?

To generate XML documentation files for a .NET project, configure your .csproj file by adding <GenerateDocumentationFile>true</GenerateDocumentationFile> to the <PropertyGroup>. This ensures XML docs are included in build outputs and NuGet packages.

What is the best way to document inherited .NET code members?

The best way to document inherited .NET code members is using the advanced <inheritdoc /> XML documentation tag. This tag allows derived classes to automatically inherit XML documentation from their base classes or interfaces.

How do I suppress CS1591 warnings for internal APIs in .NET?

To suppress CS1591 warnings for internal APIs in .NET, apply specific warning suppression strategies. This prevents the compiler from requiring XML documentation comments on internal or private members where they are unnecessary.

What XML documentation tags are required for C# IntelliSense support?

Required XML documentation tags for C# IntelliSense support include standard tags like <summary>, <param>, <returns>, and <exception>. Documenting all public members with these tags provides excellent code clarity for API consumers.

When do I need to add XML documentation comments to a NuGet library?

You need to add XML documentation comments to a NuGet library when publishing public APIs. Documenting all public members correctly ensures consumers receive proper IntelliSense support and can easily understand and use your API.