skills.rest
darylmcd
darylmcdCOMMUNITY
Explore all skills by this author →
GitHub

document

Generate XML doc comments for undocumented public C# APIs using Roslyn analysis.

Updated Mar 13, 2026
Search Tags:#csharp#code-quality#roslyn#api-documentation#xml-doc-comments#undocumented-apis
One-click install
npx skills add https://github.com/darylmcd/Roslyn-Backed-MCP --skill document-darylmcd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/darylmcd/Roslyn-Backed-MCP/tree/main/skills/document
Command: npx skills add https://github.com/darylmcd/Roslyn-Backed-MCP --skill document-darylmcd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The skill analyzes C# public APIs and generates accurate XML documentation comments using Roslyn semantic analysis to improve code readability and maintainability.

Core Features & Use Cases

  • Generate XML doc comments for undocumented or poorly documented public APIs to resolve CS1591 warnings.
  • Validate documentation accuracy, preserve existing comments, and assist in maintaining API surface clarity across libraries and projects.
  • Use in workflows to rapidly bring codebases up-to-date with consistent, reviewer-friendly documentation.

Quick Start

Provide a file path or type name to document, or run with no input to scan the workspace for the most critical undocumented public APIs.

Frequently Asked Questions about document

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

FAQPage Schema
How do I auto-generate XML doc comments for undocumented C# APIs?▼

You can auto-generate XML doc comments for undocumented public C# APIs by using Roslyn semantic analysis, producing accurate, well-formed XML documentation without altering code behavior.

What is the best way to resolve CS1591 warnings across a large codebase?▼

Resolving CS1591 warnings involves generating missing XML documentation for public APIs. Scanning the workspace with Roslyn identifies undocumented members and outputs consistent, reviewer-friendly XML docs to clear the warnings.

Can I generate API documentation for an entire C# workspace at once?▼

Yes, you can document an entire C# workspace by running with no specific input to scan for the most critical undocumented public APIs, or by targeting specific files and type names for focused documentation generation.

Does generating XML documentation comments modify my existing C# code behavior?▼

Generating XML documentation does not modify code behavior. The Roslyn-based analysis reads source code to output well-formed XML doc comments, preserving existing comments and validating documentation accuracy while maintaining functionality.

How do I document poorly documented public APIs in a C# library?▼

To document poorly documented public APIs in a C# library, Roslyn analysis reads the source code and generates accurate XML doc comments, helping maintain API surface clarity and improve code readability across the project.

Related Skills

Explore More Software Engineering Skills→
darylmcddarylmcd

semantic-find

Find C# code by natural-language description via the Roslyn MCP server.

Community
Advanced
changjian-wangchangjian-wang

Markdown Formatting Skill

Format documentation into Markdown and C# XML doc comments.

Community
Basic
AGIBuildAGIBuild
10

dotnet-xml-docs

Write and manage XML documentation comments for .NET code.

Community
Intermediate
darylmcddarylmcd

exception-audit

Classify catch blocks in a Roslyn workspace by exception type and boundary risks.

Community
Advanced