summary

<summary>

Flexibler und müheloser API -Referenzgenerator für .NET.

Verwendung

Derzeit ist der Generator ziemlich jung. Um es zu verwenden, sollten Sie Summary (CORE), Summary.Roslyn (Parser) und Summary.Markdown (Renderer)) herunterladen.

Hier ist ein einfacher Code-Snippet, der Dateien im angegebenen Verzeichnis analysiert und in das Markdown-Format verwandelt:

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

Beispiele

Überprüfen Sie das DOCS -Verzeichnis: Es ist die Summary , die durch Summary erzeugt wird.