summary

<Сводка>

Гибкий и легкий справочный генератор API для .NET.

Использование

В настоящее время генератор довольно молод. Чтобы использовать его, вы должны загрузить пакеты Summary (Core), Summary.Roslyn (Parser) и Summary.Markdown (рендеринг).

Вот простой кодовой шнур, который анализирует файлы в указанном каталоге и превращает их в формат Markdown:

 // The folder you want to parse the `*.cs` files from.
const string input = "./src" ;

// The folder you want to put the generator output into.
const string output = "./docs" ;

await new SummaryPipeline ( )
    . UseRoslynParser ( input )
    . UseMdRenderer ( output )
    . UseDefaultFilters ( )
    . Run ( ) ; 

Примеры

Рассмотрим проверку каталога DOCS: это Summary изложение, созданное Summary .