XML Documentation

Kanject's API extensions read your XML doc comments at startup and flow them into Swagger/OpenAPI, client SDK generation, and error-response schemas — no duplication between code and docs.

Enable doc generation

Add this to every service .csproj:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

Supported tags

• <summary> — becomes the OpenAPI operation summary and controller description
• <remarks> — long-form description rendered as markdown in Swagger UI
• <param> — parameter descriptions pulled onto each argument
• <response> — paired with [ProducesResponseType] for per-status-code docs
• <returns> — shown on the successful response schema