VS 2017 WebAPI Help Page - No Document Provided

前端 未结 3 1506
春和景丽
春和景丽 2021-01-13 18:18

I have followed the steps at MSDN, and other SO questions, to setup documenting and to have the XML comments show in the descriptions section of the help page. However, I am

3条回答
  •  佛祖请我去吃肉
    2021-01-13 19:16

    API help not show Body Parameters descriptions. In class properties missing description info. Just add DescriptionAttribute to property:

        [Description("Simple description")]
        public string Text { get; set; }
    

    This is my fix:

                public string GetDocumentation(MemberInfo member)
                {
                    string memberName = String.Format(CultureInfo.InvariantCulture, "{0}.{1}", GetTypeName(member.DeclaringType), member.Name);
                    string expression = member.MemberType == MemberTypes.Field ? FieldExpression : PropertyExpression;
                    string selectExpression = String.Format(CultureInfo.InvariantCulture, expression, memberName);
                    XPathNavigator propertyNode = _documentNavigator.SelectSingleNode(selectExpression); 
                    var result = GetTagValue(propertyNode, "summary") ?? GetDescription(member);
                    return result; 
                }
                private static string GetDescription(MemberInfo memberInf)
                {
                    var result = (memberInf.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute)?.Description;
                    return result;
                }
    

    screenshot

提交回复
热议问题