RicoSuter/NSwag

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

Open

#3 422 ouverte le 20 avr. 2021

Voir sur GitHub
 (1 commentaire) (2 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration

Métriques du dépôt

Stars
 (6 291 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Implémentez l'analyse des balises <c> dans les commentaires XML et rendez les comme du code en ligne similaire aux backticks en markdown.
Stack technique
csharp
Domaine
documentationapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
csharpxml comments
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70