RicoSuter/NSwag

Support for <c>...</c> in XML-Comments

Open

#3422 aperta il 20 apr 2021

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)C# (1189 fork)batch import
help wantedproject: NSwag.SwaggerGeneration

Metriche repository

Star
 (6291 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Hi Rico,

when documenting my APIs I sometimes add text enclosed in <c>...</c> tags to show some kind of constant values. Visual Studios IntelliSense displays the text between the tags using a monospaced font. It's comparable to the markdown notation of `...`.

At the moment, the SwaggerUI doesn't support <c>...</c> but it already does support the markdown notation.

Please add support for <c>...</c> too.

Thanks in advance! Max

Guida contributor

Direzione di ricerca
Implementa l'analisi dei tag <c> nei commenti XML e renderizzali come codice inline simile ai backtick in markdown.
Tech stack
csharp
Dominio
documentationapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
csharpxml comments
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70