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

Home Posts Topics Members FAQ

Is it possible to programatically get the <summary> text of a class,property or method?

I'm currently working on giving my plugins space in my settings.xml
file, actually, that's now working - however I would like to display
each of the plugin's "setting" property summaries in the details section
of the datagrid that I am using to update their values. I was wondering
if there was a way to access this information. (hopefully that's not too
confusing).

I assume there is because I can load up a dll file in my app called
let's say plugin.dll and once I call it I can do things like
plugintype.foo and get a description in some popup text of what that
property, method, etc's summary is.

Thanks in advance,
Benny
Dec 6 '05 #1
3 1552
I just noticed tg.foobar's message about property grid... is this what I
should be using?
[CategoryAttribute("Dates"),
DescriptionAttribute("Actual date mail was received by customer")]

Benny Raymond wrote:
I'm currently working on giving my plugins space in my settings.xml
file, actually, that's now working - however I would like to display
each of the plugin's "setting" property summaries in the details section
of the datagrid that I am using to update their values. I was wondering
if there was a way to access this information. (hopefully that's not too
confusing).

I assume there is because I can load up a dll file in my app called
let's say plugin.dll and once I call it I can do things like
plugintype.foo and get a description in some popup text of what that
property, method, etc's summary is.

Thanks in advance,
Benny

Dec 6 '05 #2
On Mon, 05 Dec 2005 19:41:52 -0500, Benny Raymond
<be***@pocketrocks.com> wrote:
I just noticed tg.foobar's message about property grid... is this what I
should be using?
[CategoryAttribute("Dates"),
DescriptionAttribute("Actual date mail was received by customer")]


Yes, attributes are a better way to do this. Attributes are embedded
in the compiled DLL file so you can get them via reflection.

XML comments are not embedded in the DLL file. They are kept in a
separate XML file, and that's the file that Visual Studio is analyzing
to pop up those helpful messages.
--
http://www.kynosarges.de
Dec 6 '05 #3
Then you should parse the XML file and get such info.
VS.NET also does it that way. If you add reference to a library (say,
log4net.dll) you won't get tooltip until you put its xml comments file
in the same folder.

Dec 6 '05 #4

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

Similar topics

3
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
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
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
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
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
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
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
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
by: Arne Garvander | last post by:
How do I add a summary remark to a C# class? -- Arne Garvander (I program VB.Net for fun and C# to get paid.)
0
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
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...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
1
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
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
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,...
1
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...
0
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
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 ...

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.