在Visual Studio 2015中c#xml评论更改

时间:2015-10-07 17:39:46

标签: c# visual-studio xml-comments

我在使用web api控制器方法的xml注释时遇到问题。我有一个类有几个属性作为此方法的参数。当我想在方法中为该类中的属性添加描述时,它使用额外的扩展来构建它,并且swagger无法解释其UI的文档。这在visual studio 2013中运行得很好,但在2015年它将输出更改为xml文档文件。

我的方法xml评论:

/// <summary>
    /// Get alerts for your Id.  
    /// </summary>
    /// <param name="Id"></param>
    /// <param name="alertRequest"></param>
    /// <param name="alertRequest.category">Accepted Values: examples of accepted values are...</param>

我的方法:

[HttpGet]
    public IHttpActionResult GetOpenAlerts(Guid Id, [FromUri] AlertRequest alertRequest){}    

在Visual Studio 2013中编译时的XML输出:

name="Api.Controllers.AlertController.GetOpenAlerts(System.Guid,Api.Domain.Models.AlertRequest)">
        <summary>
        Get alerts for your Id.  
        </summary>
        <param name="Id"></param>
        <param name="alertRequest"></param>
        <param name="alertRequest.category">Accepted Values: examples of accepted values are ...</param>
        <returns></returns>``

Visual Studio 2015中的输出:

<member name="Api.Controllers.AlertController.GetOpenAlerts(System.Guid,Api.Domain.Models.AlertRequest)">
        <summary>
        Get alerts for your Id. 
        </summary>
        <param name="Id"></param>
        ***<param name="alertRequest.category.category"***>Accepted Values: examples of accepted values are...</param>
        <returns></returns>

我是否需要在visual studio 2015中更改xml评论的设置?为什么会自动添加额外的扩展名并复制属性?

0 个答案:

没有答案