14

swagger/swashbuckle を使用して Web Api 2 に実装された API のドキュメントを生成しています。

認識される唯一の xml ドキュメント タグは<summary>、<remarks>と<param>です。
これは<para>、タグを使用してテキストを新しい行または段落にフォーマットすることができないことを意味します。ドキュメントの実装ノート エントリでは、すべてが連続した長い段落として生成されます。

これを行う方法はありますか？

4

9 に答える 9

22

<br />これを実現するには、コメントにタグを追加するだけでよいことがわかりました。
追加:

/// <br />

生成されたドキュメントで改行が発生します。

于 2015-09-14T08:17:49.180 に答える
7

達成するもう 1 つの方法は、カスタム OperationFilter を作成し、次の説明に従って xml ドキュメント タグを使用することです。

https://github.com/domaindrivendev/Swashbuckle/issues/258

お役に立てれば

サム

于 2015-09-22T14:09:07.447 に答える
4

Visual Studio 2019 (.net core 3.1) を使用すると、html のコメントを使用できます。を使用して、すべてを 1 行で実行できます<br />。下線や太字など、他の HTML タグも試しました。 

/// <summary>
    /// test
    /// </summary>
    /// <remarks><u>underline</u> "test line 1" <br /><b>Bold</b> "test line 2"  </remarks>

ここに画像の説明を入力

于 2020-04-26T13:49:35.797 に答える
0

長い検索の結果、*** は太字のテキストであることがわかりました。同じ件名ではないことはわかっていますが、ここにいる誰かにとって役立つと確信しています。

例 ：

***400 - BadRequest When any parameter is out of specification.***

于 2020-08-20T14:33:47.323 に答える