WebApi帮助页面:不要在XML文档中转义HTML

Question

我正在为我的ASP.NET Web API帮助页面使用XML文档,如下所示.我想知道是否有办法在评论中包含html,使其在网页上呈现,而不是被删除/忽略/转义.
具体来说,我正在寻找一种创建换行符的方法,但是能够创建项目符号列表等等会很棒!

Ex /我希望能够做到这样的事情:

/// <summary>
/// CRUD operations for SalesDocument<br/>
/// This is a new line
/// </summary>
[RoutePrefix("api/SalesDocument")]
public partial class SalesDocumentController : ApiController

并将它显示在帮助页面上,如下所示:

CRUD operations for SalesDocument 
This is a new line.

而不是这样:(在这种情况下,<br/>以某种方式被删除 - 如果我尝试使用<p>标签,它们只是被转义)

CRUD operations for SalesDocument This is a new line.

*我已经尝试过<para>工具提示的多个帖子所建议的标记,但这不适用于我的帮助页面.

任何建议都非常感谢!

Answer 1

在安装的XmlDocumentationProvider.cs文件中Areas\HelpPage,您可以查找名为的方法GetTagValue.这里从修改的返回值node.Value.Trim()来node.InnerXml.

private static string GetTagValue(XPathNavigator parentNode, string tagName)
{
    if (parentNode != null)
    {
        XPathNavigator node = parentNode.SelectSingleNode(tagName);
        if (node != null)
        {
            return node.InnerXml; 
        } 
    }

    return null;
}

现在打开已安装的文件Areas\HelpPage\Views\Help\DisplayTemplates\ApiGroup.cshtml并修改以下行:

<p>@controllerDocumentation</p>

至

<p>@Html.Raw(controllerDocumentation)</p>