如何制作ASP.NET WEB API帮助页面Xml文档注释有新行

Question

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

Answer 1

这里也提出了类似的问题:Web Api帮助页面 - 不要在xml文档中转义html,并且接受的答案(由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并根据它找到要更改的文件.