asp.net-web-api - 如何使ASP.NET WEB API帮助页面Xml文档注释具有新行

Question

我有一个使用ASP.NET WEB API开发的rest api。我使用帮助页面nuget包来创建文档。我遇到的一个问题如下。对于我的模型对象，我有xml文档注释，它们成为模型每个成员的帮助页面上的描述。我希望描述的某些部分换行，但注释中的所有内容都作为一个段落出现。我试图在注释中添加<br/>，但没有帮助。有谁知道如何实现这一目标？

Answer 1

在这里提出了类似的问题：Web Api Help Page- don't escape html in xml documentation和accepted answer（由ASP.NET Web API团队成员之一Kiran Challa给出）描述了解决方法。

我只是自己尝试过，而且效果很好。

但是，我没有在代码注释中添加<br/>，而是将建议的解决方案从以下位置更改：

return node.InnerXml;

至：

return node.InnerXml.Replace("\r\n", "<br/>").Replace("\n", "<br/>");

...并在评论中指出，可能需要在几个地方添加@Html.Raw()，即ApiGroup.cshtml，HelpPageApiModel.cshtml和ResourceModel.cshtml以及一些局部视图。

为了弄清楚我必须更改哪些视图，我基本上只是在Chrome中启动了调试器，以帮助我检查html并基于该位置找到要更改的文件。