Overview

A lightweight and efficient tool for parsing, and managing C# XML documentation comments.

BitzArt.XDoc

BitzArt.XDoc is a lightweight .NET library for parsing and accessing XML documentation comments from your C# code. It provides an intuitive API to retrieve documentation for:

• Types/classes
• Properties
• Methods
• Fields

using BitzArt.XDoc;
...

var xdoc = new XDoc();

var typeDocs = xdoc.Get(typeof(MyType));
var propertyDocs = xDoc.Get(typeof(MyType).GetProperty(nameof(MyType.PropertyOne)));

BitzArt.XDoc.PlainText

BitzArt.XDoc.PlainText is an extension package for BitzArt.XDoc that enables rendering XML documentation comments into plain text.

using BitzArt.XDoc;
using Xdoc.Renderer.PlaintText;

...
    
var xdoc = new XDoc();

var typeDescrption = xDoc.Get(typeof(MyType)).ToPlainText();
var propertyDescrption = xDoc.Get(typeof(MyType).GetProperty(nameof(MyType.PropertyOne))).ToPlainText();

BitzArt.XDoc.EntityFrameworkCore

Features:

BitzArt.XDoc.EntityFrameworkCore is an extension library that bridges XML documentation comments from C# code to Entity Framework Core database objects.

Example 1: Configure comments for all entities in your DbContext

using BitzArt.XDoc;
using Xdoc.Renderer.PlaintText;
using BitzArt.XDoc.EntityFrameworkCore
...

services.AddScoped<EntitiesCommentConfigurator>();

...

public class MyDbContext : DbContext 
{
    private readonly EntitiesCommentConfigurator _commentConfigurator;
    
    public MyDbContext(DbContextOptions options, EntitiesCommentConfigurator commentConfigurator) : base(options)
    {
        _commentConfigurator = commentConfigurator;
    }
    
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        
        // Configure comments for all entities
        _commentConfigurator.ConfigureComments(modelBuilder);
    }
}

Example 2: Configure comments for specific properties using Fluent API

using BitzArt.XDoc;
using Xdoc.Renderer.PlaintText;
using BitzArt.XDoc.EntityFrameworkCore

...

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Customer>()
        .Property(c => c.Name)
        .MapPropertyComment<string, Customer>(c => c.Name);
}