473,795 Members | 2,929 Online
Bytes | Software Development & Data Engineering Community
+ 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 1567
I just noticed tg.foobar's message about property grid... is this what I
should be using?
[CategoryAttribu te("Dates"),
DescriptionAttr ibute("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***@pocketro cks.com> wrote:
I just noticed tg.foobar's message about property grid... is this what I
should be using?
[CategoryAttribu te("Dates"),
DescriptionAtt ribute("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
3431
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 methods in the intellisense, the summary shows up only within the namespace and if I use my classes and methods in other projects, I don’t see my summaries, only the summaries of the base class which is a .NET original class. How come?
5
1575
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 comments in the IDE. However if I add the library to another project I don't get the help. How can I make sure I pass the help around? Do you have any information on how I generate the XML and/or where I can find it to include it in a distribution?...
0
1218
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 Comment Web Pages
2
5001
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 a tooltip. But when I point at the name of a class in some other file (still in the same project), it just shows "class " and the name of the class. I looked into generating an XML file, but it produced a bunch of errors because I don't have...
4
3894
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 both ?
1
2063
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> ' Returns a String Object Containing DB ConnectionString ' </summary>
4
1262
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
1443
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 Web Service from a ASP.Net web project... /// <summary> /// Some text /// </summary>
1
1734
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
9522
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 effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10448
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
10217
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
1
10167
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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
10003
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 protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
9046
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, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
5440
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 last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
2
3730
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
2922
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 can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.