summary

<summary>

Generator referensi API yang fleksibel dan mudah untuk .NET.

Penggunaan

Saat ini, generatornya cukup muda. Untuk menggunakannya, Anda harus mengunduh Summary (Core), Summary.Roslyn (parser) dan Summary.Markdown (renderer) paket.

Berikut adalah snippet kode sederhana yang mem-parses file di direktori yang ditentukan dan menjadikannya ke dalam format penurunan harga:

 // 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 ( ) ; 

Contoh

Pertimbangkan untuk memeriksa direktori Docs: Ini adalah ringkasan Summary yang dihasilkan oleh Summary .