473,485 Members | 1,473 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

<summary>

How do I add a summary remark to a C# class?
--
Arne Garvander
(I program VB.Net for fun and C# to get paid.)
May 10 '06 #1
1 1725
Arne,

Just use the /// before the item you want to provde a summary for (in
this case, before the class declaration), and it will appear in your XML
documentation.

Hope this helps.

--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Arne Garvander" <Ar***********@discussions.microsoft.com> wrote in message
news:EF**********************************@microsof t.com...
How do I add a summary remark to a C# class?
--
Arne Garvander
(I program VB.Net for fun and C# to get paid.)

May 10 '06 #2

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

Similar topics

3
3402
by: Sam | last post by:
I have an extended class in a dll and have put summaries for each method like this /// <summary> /// Removes all occurences of a given object. /// </summary> The problem is that when I see my...
5
1560
by: news.bellatlantic.net | last post by:
I added these comments "///" (below is an example) to help the developers use the classes and methods I am adding the library. When I instantiate an object in the same project I get help from the...
0
1204
by: Mark Siffer | last post by:
Does anyone know why when you have something like public enum MyEnum { ///<summary>first item..blah blah blah</summary> a = 0, b = 1, c = 2 } and you run from the vs ide Toos-->Build...
2
4976
by: carl.manaster | last post by:
Hi, Within my project, I've got a number of classes in separate files. When I point at the name of a class in the file in which it is defined, it shows the <summary> information for the class in...
4
3866
by: Edward Diener | last post by:
I really do not understand the difference between the <summary> and <value> XML document tags for a property. Why would one use one as opposed to the other for a property, and when would one use...
1
2037
by: Paul | last post by:
Hi, Does anyone know how to get Intellisense in VB (VS2003) to display the content of the <summary> attribute as it does in C#? I have put the following in code with no luck ... ' <summary>...
4
1245
by: Bruno Piovan | last post by:
Hi, I got a example code and there are some '/ <Summary> '/ bla bla bla bla bla '/</Summary> what does that means??? thanks
6
1424
by: Ambuj | last post by:
Can anyone please help me understand why this is not working?!?! I have got this code in a C# Web service project, the project compiles correctly but I can't see the description when I access the...
1
1457
by: | last post by:
Is there a setting/configuration that will open a new cs file WITHOUT "<summary> ... </summary>" and "// ... //TODO: .. //"? Thanks. Haji
0
7090
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
6960
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
1
6825
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
7275
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
5418
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
0
3063
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
0
1376
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated ...
1
595
muto222
php
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
0
247
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence...

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.