5

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

4

1 回答 1

9

这里提出了一个类似的问题:Web Api Help Page- 不要在 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.cshtmlHelpPageApiModel.cshtmlResourceModel.cshtml以及一些部分视图。

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

于 2014-08-23T16:58:05.093 回答