Notes on writing C# APIs

CSharpAPINotes.md

API Documentation: Generation from XML Comments

Note: This applies to .net 6 LTS

1. Turn on XML Documentation generation in the project in Properties-Build-Output select Documentation File
2. Modify the AddSwaggerGen line in the program.cs file

builder.Services.AddSwaggerGen( c =>
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory,
        $"{Assembly.GetExecutingAssembly().GetName().Name}.xml")));

Note: This assumes that you are creating the xml documentation file in the default location and picking it up from there.