RicoSuter/NSwag

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

Open

#3.422 aberto em 20 de abr. de 2021

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)C# (1.189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration

Métricas do repositório

Stars
 (6.291 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
Implemente a análise de tags <c> em comentários XML e renderize as como código inline semelhante a crases no markdown.
Pilha de tecnologia
csharp
Domain
documentationapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
csharpxml comments
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70