0

APIメソッドの ヘルプ ページを作成するために、このASP.NET Web API のヘルプ ページの作成およびASP.Net WebApi ヘルプ ページ で説明されているように、xml ドキュメントが使用されています。私のapi's署名の1つは次のようなものです:

        /// <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)

PlacesViewModel戻り値の型を文書化する必要があることを除いて、xml 文書は正しい です。実際に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; }
}

しかし、それは機能せず、まるでxmlコメントがないかのようPlacesViewModelに、表の説明の列の値が空のヘルプページにクラスが出席します。PlacesViewModelなぜドキュメントを提供できるのかPlacesViewModel

同じプロジェクトに移動すれば、PlacesViewModelうまくいきます!

4

0 に答える 0