RicoSuter/NSwag

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

Open

#3422 opened on Apr 20, 2021

View on GitHub
 (1 comment) (2 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration

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

Contributor guide

Tech stack
csharp
Domain
documentationbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of regexFamiliarity with XML comments
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look into the XML documentation comment processing in NSwag, likely in the Nustache or Swagger generation modules. The issue requests converting `<c>text</c>` to monospaced formatting (e.g., backticks). Search for existing handling of `<code>` or similar tags to replicate pattern. Check files like 'XmlDocumentationAdapter.cs' or related comment parsers. Add a regex replacement or transformation step.