0

对于为API方法创建帮助页面,已使用 xml 文档作为 创建 ASP.NET Web API帮助页面和ASP.Net WebApi 帮助页面 的描述。我的api's签名之一是这样的:

        /// <summary>
        ///  this is getting a place's information
        /// </summary>

        /// <param name="placeKey">Unique key of place</param>
        /// <param name="checkIn">Checkin date </param>
        /// <param name="checkOut">CheckOut date </param>
        /// <returns>
        ///        Place's Information
        /// </returns>
    Core.Services.APIViewModels.PlacesViewModel GetPlaceInformation(string categoryKey, string placeKey, string checkIn , string checkOut)

xml 文档是正确的,只是我们需要记录 PlacesViewModel返回类型。实际上,这PlacesViewModel是解决方案中另一个项目中的视图模型。已为其提供了 xml 注释,如下所示:

    /// <summary>
    /// a place information.</summary>   
    public class PlacesViewModel
        {
        /// <summary>
        ///unique number of place</summary>
        public long PlaceId { get; set; }
        /// <summary>
        ///  place's name</summary>
        public string PlaceName { get; set; }
        /// <summary>
        /// places's key</summary>
        public string Key { get; set; }
}

但它不起作用,并且PlacesViewModel班级参加了帮助页面,表中描述列的值为空,PlacesViewModel就好像没有针对它们的 xml 注释一样。怎么能提供文件PlacesViewModel

如果PlacesViewModel移动到同一个项目,它会工作得很好!

4

0 回答 0