473,320 Members | 1,987 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,320 software developers and data experts.

Using XML Documentation Comments

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?
Nov 22 '05 #1
1 1302
"Shawn Melton" <Sh*********@discussions.microsoft.com> wrote in message
news:70**********************************@microsof t.com...
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.
--
Regards,
John MacIntyre
http://www.johnmacintyre.ca
Specializing in; Database, Web-Applications, and Windows Software
Nov 22 '05 #2

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

3
by: Mikey At Work | last post by:
I'm looking for opinions on the several HTML documentation generators available for Python. We're trying to standardize the documentaion used for an upcoming project. Specifically, I'm looking...
17
by: Bart Nessux | last post by:
How can one view the contents of a queue? I'd like to verify that the queue has the same number of objects as the list that has been put into it. Also, should one think of a queue as static or...
3
by: C# Learner | last post by:
What are your views on XML documentation comments? I always comment every class using <summary> tags, and comment *some* methods. A lot of C# code that I've seen written by others uses...
14
by: Don Wash | last post by:
Hi There! In C# you can use /// to add comments that can produce XML documentation. What about in VB???? Thanks, Don
5
by: WStoreyII | last post by:
Is there some sort of a preset way for compiling documetation about an assembly or a project. The Reason that i ask this is that sometimes when i look at examples for code i see things like this....
2
by: JH | last post by:
In C# you can use /// to put comments and then create and XML documentation by going to Tools/Build web comments. Can you do this in VB.NET ? If not what Plugins do I need? Any help is...
6
by: Clive Dixon | last post by:
It's a bit of a PITA to duplicate XML comments in such a scenario as where you want to give a class method implementing an interface method exactly the same documentation (or part thereof) as the...
40
by: GTi | last post by:
Is there any source code documentation tools available for Visual Studio 2005 ? I have created a LIB that must be documented. Must I do it by hand or is it some kind of tools to pre document my...
3
by: ano | last post by:
Hi all, I try to add an XML fragment into C# Documentation Comments like this: /// <example> ///<code> ///<book> /// <name>Book1</name> ///</book> ///</code>
5
by: Bob Altman | last post by:
I thought I read somewhere in the MS documentation that XML documentation is compiled in C++, but the C++ code editor obviously doesn't do anything interesting when I enter "///". What's the deal...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.