Getting a method/parameters xml comment dynamically

Question

So you know how your able to define a method comment such as

    /// <summary>
    /// Finds the site and information by site ID.
    /// </summary>
    /// <param name="siteID">The site ID.</param>
    /// <param name="customerLink">The customer link.</param>
    /// <returns></returns>
    public static Site FindSiteAndInformationBySiteID(int siteID, int customerLink)

Is there any way that you can retrieve this in code. By this I don't mean parsing the .cs file but actually getting it so I can use it. Something like

<method>.XMLComment

Thanks in advance!

Nick · Accepted Answer · 2010-02-19 15:05:27Z

6

Go into the project settings and in the Build tab, check the box for XML Documentation File. This will output all the XML comments to the XML file you specify. Then you can use whatever code method you would normally use to read in the XML.

answered Feb 19, 2010 at 15:05

Nick

5,9651 gold badge31 silver badges38 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

stakx - no longer contributing Over a year ago

I agree with this solution. The reason why you need to do this is because XML comments are not written to the assembly (which is why reflection doesn't and can't offer the capability to access comments), therefore you need to tell the compiler to write them to a different file.

Collectives™ on Stack Overflow

Getting a method/parameters xml comment dynamically

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related