如何使ASP.NET WEB API帮助页面的Xml文档注释换行

5

我有一个使用ASP.NET WEB API开发的REST API。我使用了帮助页面nuget包来创建文档。我遇到的问题是,对于我的模型对象,我有XML文档注释,它们成为每个模型成员的帮助页面描述。我想让描述的某些部分在新行上,但是注释中的所有内容都作为一个段落呈现。我尝试在注释中添加<br/>,但没有帮助。有人知道如何实现这一点吗?

1个回答

9
类似的问题已经在这里提出:Web Api Help Page- don't escape html in xml documentation,并且被接受的答案(由 ASP.NET Web API 团队成员之一的Kiran Challa给出),描述了一个解决方法。
我自己试过了,可以正常工作。
然而,我没有像在我的代码注释中添加<br/>那样,而是将建议的解决方案从: return node.InnerXml; 改为: return node.InnerXml.Replace("\r\n", "<br/>").Replace("\n", "<br/>"); ... 正如评论中指出的那样,可能有几个地方需要添加@Html.Raw(),即ApiGroup.cshtmlHelpPageApiModel.cshtmlResourceModel.cshtml以及一些局部视图。
为了找出需要更改哪些视图,我基本上只需在 Chrome 中启动调试程序,以帮助我检查 HTML 并根据此定位要更改的文件。

1
不确定这个方法是否可行,但它更加简洁:return node.InnerXml.Replace(Environment.NewLine, "<br>"); - Jon49

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接