Создание страниц справки для ASP.NET Web API и документирование типов возврата

Для создания страницы справки для API методы, XML-документация была использована, как описано в этом разделе Создание страниц справки для ASP.NET Web API и ASP.Net WebApi Help Page. Один из моих 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 перейти на тот же проект, он будет работать хорошо!

0 ответов

Другие вопросы по тегам