dotnet-xml-docs

Generate and manage XML documentation comments for .NET code.

1|Updated Feb 22, 2026
One-click install
npx skills add https://github.com/rudironsoni/dotnet-agent-harness --skill dotnet-xml-docs-rudironsoni
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-xml-docs
Source: https://github.com/rudironsoni/dotnet-agent-harness/tree/main/.rulesync/skills/dotnet-xml-docs
Command: npx skills add https://github.com/rudironsoni/dotnet-agent-harness --skill dotnet-xml-docs-rudironsoni

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

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

Core Features & Use Cases

  • Standard & Advanced Tags: Supports all common XML doc tags (<summary>, <param>, <inheritdoc>, etc.).
  • MSBuild Integration: Guides on enabling <GenerateDocumentationFile> for automatic XML generation.
  • Warning Suppression: Strategies for managing CS1591 warnings for internal or undocumented members.
  • Use Case: Ensure your public NuGet library provides excellent IntelliSense by correctly documenting all public members using standard XML tags and enabling documentation file generation.

Quick Start

Enable XML documentation generation in your .NET project by adding <GenerateDocumentationFile>true</GenerateDocumentationFile> to your project's 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 comments for .NET?

To generate XML documentation comments for .NET, you add standard and advanced tags like summary, param, returns, and exception to your code, and enable <GenerateDocumentationFile>true</GenerateDocumentationFile> in MSBuild to produce the documentation file.

How do I suppress CS1591 warnings for undocumented internal APIs in C#?

To suppress CS1591 warnings for undocumented internal APIs in C#, you apply specific suppression strategies provided by the skill to exclude internal members while maintaining strict documentation requirements for public APIs.

When do I need the inheritdoc tag in .NET XML documentation?

You need the inheritdoc tag in .NET XML documentation when you want derived class members to automatically inherit documentation from their base class or interface, a feature fully supported since C# 9.0 and .NET 5+.

Does the dotnet-xml-docs skill work with .NET 8.0 projects?

Yes, the skill works with .NET 8.0 projects, using .NET 8.0+ as its baseline and requiring .NET SDK 6+ for configuring MSBuild properties like <GenerateDocumentationFile> to generate documentation files.

What is the best way to provide IntelliSense for a NuGet library?

The best way to provide IntelliSense for a NuGet library is to document all public members using standard XML tags like summary and remarks, and enable <GenerateDocumentationFile> in MSBuild to output the XML file alongside your assembly.