ASP.NET WEB API help page 显示description

1、Areas/HelpPage/App_Start/HelpPageConfig.cs

    修改 public static void Register(HttpConfiguration config):

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin")));

    path修改到bin目录下

2、Areas/HelpPage/XmlDocumentationProvider.cs

  修改构造函数为:

        public XmlDocumentationProvider(string documentPath)
        {
            if (documentPath == null)
            {
                throw new ArgumentNullException("documentPath");
            }

            var files = new[] { "adll.xml", "bdll.xml"};
            foreach (var file in files)
            {
                var path = Path.Combine(documentPath, file);
                if (File.Exists(path))
                {
                    XPathDocument xpath = new XPathDocument(path);
                    _documentNavigators.Add(xpath.CreateNavigator());
                }
            }
        }

    var files = new[] { “adll.xml”, “bdll.xml”};中枚举出自己的dll的注释xml就好了。
然后增加方法:

        private XPathNavigator SelectSingleNode(string selectExpression)
        {
            foreach (var navigator in _documentNavigators)
            {
                var propertyNode = navigator.SelectSingleNode(selectExpression);
                if (propertyNode != null)
                    return propertyNode;
            }
            return null;
        }

    然后把其它调用_documentNavigator.SelectSingleNode(selectExpression)替换为SelectSingleNode(selectExpression)

  这样,只要写好备注,生成dll时选择了XML文档文件,路径为bin目录下,help页的描述就自动生成了

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值