dotnet-documentation

What problem does it solve?

Documentation conventions for .NET (.csproj, C#) including XML docs, DebuggerDisplay attributes, and Mermaid diagrams for architecture documentation. Use when adding XML docs, DebuggerDisplay, or creating architecture diagrams in markdown. DO NOT use for web frameworks (Next.js, React, JavaScript, Node.js).

Core Features & Use Cases

• XML documentation conformance for public APIs, including summary, param, and returns tags.
• Guidance on applying [DebuggerDisplay] attributes to DTOs, entities, aggregates, and value objects to improve traceability.
• Mermaid-based architecture diagrams and structured architecture documentation to visualize components and relationships.

Quick Start

Document public APIs with XML comments, annotate types with DebuggerDisplay attributes, and include Mermaid diagrams for architecture in your project.