如何制作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（由Kiran Challa提供 - 其中一个ASP.NET Web API团队成员）描述了一种解决方法。

我自己尝试过，但效果很好。

但是，我没有在代码注释中添加<br/>，而是更改了提议的解决方案：

return node.InnerXml;

为：

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

...正如评论中所指出的，您可能需要在几个地方添加@Html.Raw()，即ApiGroup.cshtml，HelpPageApiModel.cshtml和ResourceModel.cshtml以及一些部分观点。

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