Friday, June 15, 2018

XML format for documenting what a method or class does in C#

This has this example:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

 
 

I've seen stuff like this before. When I was at FramesDirect, Anshu Jain had a name for these. It was something like dioxide comments. I can't remember. Sandcastle is a tool for making this stuff. This has a list of the suggested tags. I guess the reason for XML is to allow the comments to be easily crawlable by another tool.

No comments:

Post a Comment