asp.net-web-api - 如何使 ASP.NET WEB API HELP PAGES 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以及一些部分观点。

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