如何制作ASP.. NET WEB API HELP PAGES Xml文档注释有新行



我有一个使用ASP开发的rest api。Net web api。我使用帮助页面nuget包来创建文档。我遇到的一个问题如下。对于我的模型对象,我有xml文档注释,它们成为模型每个成员的帮助页面上的描述。我想把描述的某些部分放在新的一行,但是评论中的所有内容都是一个段落。我试图在评论中添加<br/>,但没有帮助。有人知道如何做到这一点吗?

这里也有人问过类似的问题:Web Api帮助页面-不要在xml文档中转义html和公认的答案(这是由ASP. net的一位专家Kiran Challa给出的)。. NET Web API团队成员)描述了一种解决方法。

我自己试了一下,效果很好。

但是,我没有将<br/>添加到代码注释中,而是将建议的解决方案更改为:

return node.InnerXml;

:

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

…正如评论中指出的那样,可能有几个地方需要添加@Html.Raw(),即ApiGroup.cshtml, HelpPageApiModel.cshtmlResourceModel.cshtml以及一些局部视图。

为了弄清楚我需要更改哪些视图,我基本上只是在Chrome中启动调试器来帮助我检查html并找到要更改的文件。

最新更新