以前我用微軟的HelpPage來自動生成的webAPI幫助文檔。在使用了一段時間后發現只能顯示Controller上面寫的注釋文檔內容。以前總以為是微軟這個類庫的bug。后來才明白了是由于我的設置不當。

enter description here

enter description here

enter description here

我們可以很清楚的看到，返回的`AlarmRecodrdDto`并沒有注釋文檔啊！可是我已經在類庫的中寫過了該代碼的注釋的。為毛就沒有呢？？？

其實啊，我們的注釋文檔是自動生成xml文件，再由HelpPage來讀取該xml中的注釋信息，最后展示在頁面上。那些沒有注釋的文檔是由于我們的代碼注釋沒有生成對應的注釋xml文件，所以就沒法讀取啦！！！

明白問題出在哪里了就可以動手解決問題了！！！

1. 設置指定類庫中要生成的注釋xml路徑

enter description here

enter description here

enter description here

2. 添加一個可以讀取xml文件信息的類

using System;
using System.Linq;
using System.Reflection;
using System.Web.Http.Controllers;
using System.Web.Http.Description;
using GTCASP.Website.Areas.HelpPage.ModelDescriptions;

namespace GTCASP.Website.Areas.HelpPage.Models
{
    /// <summary>A custom 
    /// <see cref="IDocumentationProvider"/> 
    /// that reads the API documentation from a collection of XML documentation files.
    /// </summary>
    public class MultiXmlDocumentationProvider : IDocumentationProvider, IModelDocumentationProvider
    {
        /*********
    ** Properties
    *********/
        /// <summary>The internal documentation providers for specific files.</summary>
        private readonly XmlDocumentationProvider[] Providers;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="paths">The physical paths to the XML documents.</param>
        public MultiXmlDocumentationProvider(params string[] paths)
        {
            this.Providers = paths.Select(p => new XmlDocumentationProvider(p)).ToArray();
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetDocumentation(MemberInfo subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetDocumentation(Type subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetDocumentation(HttpControllerDescriptor subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetDocumentation(HttpActionDescriptor subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetDocumentation(HttpParameterDescriptor subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }

        /// <summary>Gets the documentation for a subject.</summary>
        /// <param name="subject">The subject to document.</param>
        public string GetResponseDocumentation(HttpActionDescriptor subject)
        {
            return this.GetFirstMatch(p => p.GetDocumentation(subject));
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Get the first valid result from the collection of XML documentation providers.</summary>
        /// <param name="expr">The method to invoke.</param>
        private string GetFirstMatch(Func<XmlDocumentationProvider, string> expr)
        {
            return this.Providers
                .Select(expr)
                .FirstOrDefault(p => !String.IsNullOrWhiteSpace(p));
        }
    }
}

請將類添加到如下位置

enter description here

3. 修改HelpPageConfig.cs中的代碼。

enter description here

做完以上設置后，大功告成。妹子，現在我們可以出去玩啦！！！

咦，妹子人呢？