Generate documentation with AI

AI can help you make XML documentation both automatic and useful.

Generate documentation

High quality software requires high quality documentation. But let's face it, writing docs just isn't a fun part of software development for most folks. But now we have AI to create those docs for us. These XML docs generated by AI aren't just to help devs understand the code, but these XML comments are also used by tools to help explain what the code is supposed to do.

To generate XML documentation in Rider, press Alt + Enter on the method or class you want to document. Select AI Actions then Write documentation. The AI Assistant examines the code and creates XML documentation in natural language that is understandable and useful. Now there's no excuse for not having XML documentation for your code!


Related Resources

File-scoped namespaces and types
File-scoped namespaces and types
Organize code better and reduce bugs by using file-scoped namespaces and objects.
C# Top-level statements
C# Top-level statements
Use top-level statements in C# to reduce boilerplate code.
Global usings
Global usings
Organize `using` statements so they're out of your way.