Programmatically get Summary comments at runtime

by

A Workaround – Using reflection on Program.DLL/EXE together with Program.XML file

If you take a look at the sibling .XML file generated by Visual Studio you will see that there is a fairly flat hierarchy of /members/member.
All you have to do is get hold on each method from your DLL via MethodInfo object. Once you have this object you turn to the XML and use XPATH to get the member containing the XML documentation for this method.

Members are preceded by a letter. XML doc for methods are preceded by “M:” for class by “T:” etc.

Load your sibling XML

string docuPath = dllPath.Substring(0, dllPath.LastIndexOf(".")) + ".XML";

if (File.Exists(docuPath))
{
  _docuDoc = new XmlDocument();
  _docuDoc.Load(docuPath);
}

Use this xpath to get the member representing the method XML docu

string path = "M:" + mi.DeclaringType.FullName + "." + mi.Name;

XmlNode xmlDocuOfMethod = _docuDoc.SelectSingleNode(
    "//member[starts-with(@name, '" + path + "')]");

Now scan childnodes for all the rows of “///”
Sometimes the /// Summary contains extra blanks, if this bothers use this to remove

var cleanStr = Regex.Replace(row.InnerXml, @"\s+", " ");

More Related Contents:

  1. How to get a property value based on the name
  2. Getting Nested Object Property Value Using Reflection
  3. Comparing Object properties using reflection
  4. ASP.NET – AppDomain.CurrentDomain.GetAssemblies() – Assemblies missing after AppDomain restart
  5. Using parameters inserting data into access database
  6. How to create JSON string in C#
  7. Read data from SqlDataReader
  8. System.MissingMethodException: Method not found?
  9. How can I create a dynamic button click event on a dynamic button?
  10. Testing if object is of generic type in C#
  11. GridView must be placed inside a form tag with runat=”server” even after the GridView is within a form tag
  12. Export DataTable to Excel File
  13. Getting a System.Type from type’s partial name
  14. ASP.Net URLEncode Ampersand for use in Query String
  15. How to get a property value using reflection
  16. Queuing in OneWay WCF Messages using Windows Service and SQL Server
  17. Getting a POST variable
  18. C#: how to get an object by the name stored in String?
  19. User in Entity type MVC5 EF6
  20. How to write a transaction to cover Moving a file and Inserting record in database?
  21. How to Get the HTTP Post data in C#?
  22. Asp .NET Button – OnClientClick=”return function()” vs OnClientClick=”function()”
  23. No IUserTokenProvider is registered
  24. How to recursively print the values of an object’s properties using reflection
  25. Making an entire row clickable in a gridview
  26. Explicit construction of entity type [MyClass] in query is not allowed
  27. Web Service without adding a reference?
  28. How to maintain the value of label after postback in Asp.net? [closed]
  29. difference between http.context.user and thread.currentprincipal and when to use them?
  30. How do I call a method in a Master Page from a content’s code-behind page?

Leave a Comment