PC Review


Reply
Thread Tools Rate Thread

Can you set the summary in the Object Browser?

 
 
news.microsoft.com
Guest
Posts: n/a
 
      12th Jul 2004
Hi all,

I'm trying to find a way to set a value for a method or property of my class
which will show up as summary when you look at the method/property in the
Object browser. I know that in VB6 this was done by setting the procedure
attributes but I can't find anything in .NET

Does anybody know if it's possible... and if so how?

TIA,
Friso Wiskerke


 
Reply With Quote
 
 
 
 
Herfried K. Wagner [MVP]
Guest
Posts: n/a
 
      12th Jul 2004
* "news.microsoft.com" <(E-Mail Removed)> scripsit:
> I'm trying to find a way to set a value for a method or property of my class
> which will show up as summary when you look at the method/property in the
> Object browser. I know that in VB6 this was done by setting the procedure
> attributes but I can't find anything in .NET


My FAQ:

Adding tooltips in intellisense for VB.NET assemblies and creating HTML Help
documentation:

VS.NET takes the text shown in intellisense tips from an XML file that is
provided in addition to the assembly (for example, a DLL). The XML file
must have the same name as the corresponding DLL with ".xml" appended and
has to be placed in the same folder as the assembly (assembly "Foo.dll",
XML file "Foo.dll.xml").

The format of the XML file taken by VS.NET is specified here:

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfprocessingxmlfile.asp>

For C#, VS.NET creates this XML file automatically (compiler option "/doc").
For VB.NET, that's currently not supported, but this will be possible in VB
2005.

You can create the XML file by hand, but notice that this will take a lot of
time and it will be hard to keep the file up to date when parts of the
assembly change. It's much easier to use one of the tools listed below to
create the XML file. Tools like NDOC will take the XML file and create an
HTML Help file from the XML formatted data.

One easy way to create the XML file is to provide information for tooltips
as XML comments inside the VB.NET source files and then use tools like
VB.DOC to create the XML file that contains the data. Then you can copy
this file into the assembly's directory to provide information to VS.NET
that enables it to display tooltips, or you can create a help file. The
help file can be deployed with the assembly and can be used by other
developers who use the assembly as reference.

For VB.NET 2002/2003:

VB Commenter
<URL:http://www.gotdotnet.com/team/ide/>
-> "VB Commenter"

XML Documentation
<URL:http://www.gotdotnet.com/team/vb/>
-> "XML Documentation"

VBXC - VB.NET XML Commentor
<URL:http://vbxmldoc.tor-erik.net/>

NDOC (formerly DOC.NET)
<URL:http://ndoc.sourceforge.net/>

VB.DOC
<URL:http://vb-doc.sourceforge.net/>

<URL:http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd>

XML comments will be introduced to VB in version 2005 ("Whidbey").

C# XML comments:

C# Programmer's Reference -- Recommended Tags for Documentation Comments
<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp>

--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>
 
Reply With Quote
 
Friso Wiskerke
Guest
Posts: n/a
 
      12th Jul 2004
Thanx a lot !!!
This was exactly what I was looking for

Cheers,
Friso



"Herfried K. Wagner [MVP]" <hirf-spam-me-(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> * "news.microsoft.com" <(E-Mail Removed)> scripsit:
> > I'm trying to find a way to set a value for a method or property of my

class
> > which will show up as summary when you look at the method/property in

the
> > Object browser. I know that in VB6 this was done by setting the

procedure
> > attributes but I can't find anything in .NET

>
> My FAQ:
>
> Adding tooltips in intellisense for VB.NET assemblies and creating HTML

Help
> documentation:
>
> VS.NET takes the text shown in intellisense tips from an XML file that is
> provided in addition to the assembly (for example, a DLL). The XML file
> must have the same name as the corresponding DLL with ".xml" appended and
> has to be placed in the same folder as the assembly (assembly "Foo.dll",
> XML file "Foo.dll.xml").
>
> The format of the XML file taken by VS.NET is specified here:
>
>

<URL:http://msdn.microsoft.com/library/en...rocessingxmlfi
le.asp>
>
> For C#, VS.NET creates this XML file automatically (compiler option

"/doc").
> For VB.NET, that's currently not supported, but this will be possible in

VB
> 2005.
>
> You can create the XML file by hand, but notice that this will take a lot

of
> time and it will be hard to keep the file up to date when parts of the
> assembly change. It's much easier to use one of the tools listed below to
> create the XML file. Tools like NDOC will take the XML file and create an
> HTML Help file from the XML formatted data.
>
> One easy way to create the XML file is to provide information for tooltips
> as XML comments inside the VB.NET source files and then use tools like
> VB.DOC to create the XML file that contains the data. Then you can copy
> this file into the assembly's directory to provide information to VS.NET
> that enables it to display tooltips, or you can create a help file. The
> help file can be deployed with the assembly and can be used by other
> developers who use the assembly as reference.
>
> For VB.NET 2002/2003:
>
> VB Commenter
> <URL:http://www.gotdotnet.com/team/ide/>
> -> "VB Commenter"
>
> XML Documentation
> <URL:http://www.gotdotnet.com/team/vb/>
> -> "XML Documentation"
>
> VBXC - VB.NET XML Commentor
> <URL:http://vbxmldoc.tor-erik.net/>
>
> NDOC (formerly DOC.NET)
> <URL:http://ndoc.sourceforge.net/>
>
> VB.DOC
> <URL:http://vb-doc.sourceforge.net/>
>
>

<URL:http://www.gotdotnet.com/Community/W...spx?id=112b544
9-f702-46e2-87fa-86bdf39a17dd>
>
> XML comments will be introduced to VB in version 2005 ("Whidbey").
>
> C# XML comments:
>
> C# Programmer's Reference -- Recommended Tags for Documentation Comments
>

<URL:http://msdn.microsoft.com/library/en...agsForDocument
ationComments.asp>
>
> --
> Herfried K. Wagner [MVP]
> <URL:http://dotnet.mvps.org/>



 
Reply With Quote
 
 
 
Reply

Thread Tools
Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Object Required error on Weekly Summary sheet creation davegb Microsoft Excel Programming 4 20th Mar 2008 05:06 PM
How to create a browser helper object with a clickable icon at the corner of the browser? qwu2008@gmail.com Microsoft C# .NET 0 12th Sep 2006 04:38 PM
How to display Summary in object browser =?Utf-8?B?aHVsaW5uaW5n?= Microsoft Dot NET Framework 3 31st May 2006 10:55 PM
Adding summary to object browser? tomb Microsoft VB .NET 6 8th Feb 2006 08:31 PM
File system object in to get Properties --> Summary information Microsoft ASP .NET 0 3rd Nov 2003 06:24 PM


Features
 

Advertising
 

Newsgroups
 


All times are GMT +1. The time now is 12:30 AM.