Using XML Documentation Comments

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

How would I document an enum for Intellisense to work properly? I have the
following enum:

public enum Level {A, B, C};

I can document the whole enum with a Summary tag. But how would I give each
member in the enum a description?
 
Shawn Melton said:
How would I document an enum for Intellisense to work properly? I have
the
following enum:

public enum Level {A, B, C};

I can document the whole enum with a Summary tag. But how would I give
each
member in the enum a description?

Like this :

/// <summary>
///
/// </summary>
public enum Level
{
/// <summary>
///
/// </summary>
A,
/// <summary>
///
/// </summary>
B,
/// <summary>
///
/// </summary>
C
};


Good luck.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Back
Top