RicoSuter/NSwag

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

Open

#3,422 创建于 2021年4月20日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)C# (6,291 star) (1,189 fork)batch import
help wantedproject: NSwag.SwaggerGeneration

描述

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

贡献者指南

技术栈
csharp
领域
documentationbackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic understanding of regexFamiliarity with XML comments
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.
Support for <c>...</c> in XML-Comments · RicoSuter/NSwag#3422 | Good First Issue