RicoSuter/NSwag

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

Open

#3,422 opened on 2021年4月20日

GitHub で見る
 (1 comment) (2 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド

調査方針
XMLコメント内の<c>タグを解析し、Markdownのバックティックのようなインラインコードとしてレンダリングする実装を行います。
技術スタック
csharp
領域
documentationapi
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
csharpxml comments
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70