AutoDocCommenter 1.0.0

AutoDocCommenter.NET

Automatically generates XML comments and Markdown documentation for .NET projects.

Benefits of AutoDocCommenter.NET

Full End-to-End Demo: Provides a ready-to-run example project showing how to generate documentation effortlessly.

Automatic XML Comments: Injects meaningful XML comments directly into your source code, saving hours of manual documentation.

Markdown Documentation Generation: Creates structured Markdown docs for your entire project, compatible with all frameworks including .NET 4.5+.

Roslyn-Powered Automation: Leverages Roslyn for accurate parsing and XML comment injection while supporting fallback for legacy frameworks.

One-Click Documentation: Combines XML comment injection and Markdown generation in a single run for maximum developer productivity.

Features

• Auto XML comment generation (Roslyn) for .NET 7/8 and netstandard2.0
• Markdown documentation generation for all frameworks including .NET 4.5+
• Supports multi-targeting: net8.0, net7.0, netstandard2.0, net452

Usage

Usage Guide for AutoDocCommenter.NET 1️⃣ Install the Package dotnet add package AutoDocCommenter.NET

2️⃣ Add Using Statement using AutoDocCommenter;

3️⃣ Generate XML Comments + Markdown Documentation class Program { static void Main() { // Path to your project string projectPath = @"C:\MyProject";

    // Path to output documentation
    string docsPath = Path.Combine(projectPath, "Docs");

    // Generate XML comments and Markdown docs
    AutoDocCommenter.AutoDocCommenter.GenerateAll(projectPath, docsPath);

    Console.WriteLine("Documentation generation finished!");
    Console.WriteLine($"Check the generated docs at: {docsPath}");
}

}

4️⃣ What Happens

XML Comments Injection:

Automatically adds <summary> and <param> tags to all methods in C# files.

Works on .NET 7/8 and netstandard2.0.

Skips Roslyn-based injection for legacy frameworks (net452) gracefully.

Markdown Documentation Generation:

Creates a Documentation.md file in the specified docsPath.

Includes project structure and methods with auto-generated summaries.

Compatible with all frameworks including .NET 4.5+.

5️⃣ Example Output XML in SampleClass.cs /// <summary> /// Auto-generated summary for Add /// </summary> /// <param name="a">Auto-generated description</param> /// <param name="b">Auto-generated description</param> public int Add(int a, int b) { return a + b; }

Markdown (Documentation.md)

SampleClass

Methods

Add

Summary: Auto-generated description

Greet

Summary: Auto-generated description

6️⃣ Notes

Works on all .NET versions 4.5+ and modern .NET 7/8.

Conditional compilation ensures legacy frameworks don’t break.

Combine with your CI/CD workflow to automatically maintain up-to-date documentation.