How can I get a method discription

kfy0002 1

We can get the description of a property, such as:

Attribute attribute = memberInfo.GetCustomAttribute(typeof(DescriptionAttribute));
if (attribute != null)
{
DescriptionAttribute descAttr = attribute as DescriptionAttribute;
string description = descAttr.Description;
...
}

But this code is not applicable to MethodInfo, How can I get description(or summary) from a method?

Viorel 117.2K Reputation points

2021-07-17T07:31:40.527+00:00

It seems to work. How to reproduce the problem?
Timon Yang-MSFT 9,591 Reputation points

2021-07-19T02:08:01.75+00:00

@kfy0002
There is no field or property named Description in MethodInfo, we can't get it.
You get DescriptionAttribute.Description because you (the author) defined this property in this custom attribute.
Did I misunderstand what you mean?
Could you please show us the code of DescriptionAttribute?

kfy0002 1

void SetMethodDrawingInfo(MethodInfo info)
{
    lines.Clear();
    LineDrawInfo line = new LineDrawInfo();

    //1. Draw method's body
    //1.1 typeName
    string typeName = MyConvert.GetTypeName(info.ReturnType);
    line.Add(typeName + " ", DrawPart.Type);

    //1.2 methodName
    line.Add( info.Name + "(", DrawPart.Other);

    //1.3 draw params
    ParameterInfo[] ps = info.GetParameters();
    int len = ps.Length;
    string text = null;
    if (ps.Length > 0)
    {
        int index = 0;
        foreach (ParameterInfo p in ps)
        {
            ...
        }
    }

    line.Add(")", DrawPart.Other);

    if (overloads > 1)
    {
        text = $"(+{overloads}重载)";
        line.Add(text, DrawPart.Other);
    }

    //
    lines.Add(line);

    //2. draw description          
    //2.1 get the DescriptionAttribute

    string desc = null;
    Attribute attribute = info.GetCustomAttribute(typeof(DescriptionAttribute));
    if (attribute != null)
    {
        DescriptionAttribute descAttr = attribute as DescriptionAttribute;
        desc = descAttr.Description;
    }
    if (desc == null)
        return;              
    //2.2 
    line = new LineDrawInfo();
    line.Add(desc, DrawPart.Other);
    lines.Add(line);
}

kfy0002 1 Reputation point

2021-07-19T02:55:03.607+00:00

In my app:

Visual studio

]3

How is Visual studio done?

kfy0002 1

void SetMethodDrawingInfo(MethodInfo info)
{
lines.Clear();
LineDrawInfo line = new LineDrawInfo();

 //1. Draw method's body
 //1.1 typeName
 string typeName = MyConvert.GetTypeName(info.ReturnType);
 line.Add(typeName + " ", DrawPart.Type);

 //1.2 methodName
 line.Add( info.Name + "(", DrawPart.Other);

 //1.3 draw params
 ParameterInfo[] ps = info.GetParameters();
 int len = ps.Length;
 string text = null;
 if (ps.Length > 0)
 {
     int index = 0;
     foreach (ParameterInfo p in ps)
     {
         ...
     }
 }

 line.Add(")", DrawPart.Other);

 if (overloads > 1)
 {
     text = $"(+{overloads}重载)";
     line.Add(text, DrawPart.Other);
 }

 //
 lines.Add(line);

 //2. draw description          
 //2.1 get the DescriptionAttribute

 string desc = null;
 Attribute attribute = info.GetCustomAttribute(typeof(DescriptionAttribute));
 if (attribute != null)
 {
     DescriptionAttribute descAttr = attribute as DescriptionAttribute;
     desc = descAttr.Description;
 }
 if (desc == null)
     return;              
 //2.2 
 line = new LineDrawInfo();
 line.Add(desc, DrawPart.Other);
 lines.Add(line);

}

2 answers

Timon Yang-MSFT 9,591 Reputation points

2021-07-19T08:24:27.947+00:00
We can add a specific xml summary as a comment for the method (class, etc.), and then Visual Studio will get it correctly.

/// <summary> /// This is a test method. /// </summary> public void PrintHW() { Console.WriteLine("Hello World!"); }

Programmatically get Summary comments at runtime

c# getting interface method comments

If the response is helpful, please click "Accept Answer" and upvote it.
Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.
Please sign in to rate this answer.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.
kfy0002 1 Reputation point

2021-07-20T06:40:48.933+00:00

TimonYang-MSFT:

I Will show the summary in my code editor.

I used "get method summary info" as the keyword to search the relevant web pages on the Internet and found some articles.

thank you!
Please sign in to rate this answer.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

How can I get a method discription

2 answers

Your answer