2015-09-14 3 views
6

Я создаю документацию для api, реализованной в Web Api 2, используя swagger/swashbuckle.Как добавить разрыв строки в документацию Swashbuckle?

Единственными признанными тегами документации xml являются <summary>, <remarks> и <param>.
Это означает, что я не могу использовать тег <para> для форматирования текста в новых строках или параграфах, все создается как непрерывный длинный абзац в записи Notes Notes.

Есть ли способ сделать это?

ответ

2

Другим способ достижения является созданием пользовательского OperationFilter и использовать теги XML документации, как описан в:

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

Надеется, что это помогает

Сэму

+0

Установив это как принятый ответ, это более элегантное решение. –

11

Я нашел, что вы можете просто добавить <br /> теги к комментариям для достижения этого.
Добавление:

/// <br /> 

вызовет разрыв строки в сгенерированной документации.

+0

Спасибо за это! – spinalfrontier

+0

В VS 2017 и SwashBuckle.AspNetCore 2.4 он не работает - показывает буквально '
' –

Смежные вопросы