summary

<Summary>

Générateur de référence API flexible et sans effort pour .NET.

Usage

Actuellement, le générateur est assez jeune. Afin de l'utiliser, vous devez télécharger des packages Summary (Core), Summary.Roslyn (analyser) et Summary.Markdown (rendu).

Voici un simple code de code qui analyse les fichiers dans le répertoire spécifié et les rend dans le format de marque:

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

Exemples

Envisagez de consulter le répertoire des documents: c'est le Summary généré par Summary .