csharp-docs

Generates standardized XML comments and API documentation for C# code.

Updated Aug 26, 2024

Search Tags:#code quality #csharp #documentation #dotnet #api documentation #xml documentation

Ready to run

npx skills add https://github.com/FabienDehopre/my-netatmo-24 --skill csharp-docs-fabiendehopre

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: csharp-docs
Source: https://github.com/FabienDehopre/my-netatmo-24/tree/main/.agents/skills/csharp-docs
Command: npx skills add https://github.com/FabienDehopre/my-netatmo-24 --skill csharp-docs-fabiendehopre

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers create consistent, accurate XML documentation for C# code, reducing unclear APIs and improving maintainability.

Core Features & Use Cases

XML Documentation Guidance: Provides rules for documenting public and internal C# types, members, parameters, returns, properties, and exceptions.
Documentation Best Practices: Enforces recommended XML tags, wording conventions, references, examples, and inheritance patterns.
Use Case: Improve a C# library before release by ensuring APIs have complete and standardized documentation that is easier for developers to understand.

Quick Start

Use the csharp-docs skill to review my C# API documentation and suggest XML comment improvements following best practices.

Frequently Asked Questions about csharp-docs

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

FAQPage Schema

How do I generate consistent XML documentation for C# public APIs?▼

To generate consistent XML documentation for C# public APIs, apply standardized XML comments and language-specific best practices covering types, methods, properties, constructors, parameters, returns, and exceptions to produce maintainable developer references.

What are the best practices for writing C# XML comments for a library release?▼

C# XML comments best practices for a library release involve enforcing recommended XML tags, wording conventions, references, examples, and inheritance patterns to ensure APIs are complete, standardized, and easier for developers to understand.

Can I use this approach to document internal C# types and members?▼

Yes, you can document internal C# types and members, as this approach provides specific documentation rules for both public and internal types, members, parameters, returns, properties, and exceptions.

How do I improve unclear dotnet API documentation before publishing?▼

You can improve unclear dotnet API documentation before publishing by reviewing existing code and applying accurate XML documentation structures to reduce unclear APIs and improve overall project maintainability.

What is the standard XML documentation structure for C# methods and parameters?▼

The standard XML documentation structure for C# methods requires applying accurate XML tags to document methods, parameters, returns, and exceptions, ensuring the generated developer reference remains maintainable and consistent.