Object Browser

[Ot]

(Repeated from m.p.dotnet.general. I got the advice that I could not do
this in VB, only in C#... looking for verification here)

When I use the Object Browser in the IDE to look at the functionality
provided in References, I see lovely entries headed Summary, Parameters
and/or Return Values.

If I develop a COM application (class library) and wish to make entries so
that users of my application can see those headers, how do I do that?

[Maniaque |CIA|]

On Fri, 30 Jan 2004 07:14:55 -0600, Ot <ur***@tds.invalid (use net)> wrote:

(Repeated from m.p.dotnet.general. I got the advice that I could not do
this in VB, only in C#... looking for verification here)

When I use the Object Browser in the IDE to look at the functionality
provided in References, I see lovely entries headed Summary, Parameters
and/or Return Values.

If I develop a COM application (class library) and wish to make entries
so
that users of my application can see those headers, how do I do that?

Maybe you can try this (saw it in MSDN)
public function duh()
//<summary>
//This is a super-duper summary, yeah!
//</summary>
------- The code goes here

--
.... blood, sugar, sex, magic ...
CIA = Caught In Action programmer

[Brian W]

Actually, that's C# (only) documentation comments, I think it is to
introduced in VB.NET in 2.0

BTW it works this way:

///<summary>
/// Now this is my cool summary info!
///</summary>
public int foo()
{
// Method code here
}
HTH
Brian W

Maybe you can try this (saw it in MSDN)
public function duh()
//<summary>
//This is a super-duper summary, yeah!
//</summary>
------- The code goes here

[Ot]

"Brian W" <brianw@gold_death_2_spam_rush.com> wrote in message
news:OM**************@TK2MSFTNGP09.phx.gbl...

Actually, that's C# (only) documentation comments, I think it is to
introduced in VB.NET in 2.0

I saw that. Although some examples in the MSDN documentation have stuff
like the following in VB programs.

Public Sub X(thing as object)
'/ <summary>
'/ This would describe X
'/ </summary>
'/ <param name=thing>Any object will do.</param>
The C# precompiler must actually generate some xml somewhere. This
psuedo-xml in the C# source code must be converted to something. Is there
any way to generate and embed that "by-hand"? That is, could one generate
one's own and put it where it needs to go? I don't have access to C#, only
to VB.

I don't mind writing the documentation externally from the source code
itself.

[Adam Nowotny]

Ot wrote:

"Brian W" <brianw@gold_death_2_spam_rush.com> wrote in message
news:OM**************@TK2MSFTNGP09.phx.gbl...

Actually, that's C# (only) documentation comments, I think it is to
introduced in VB.NET in 2.0

I saw that. Although some examples in the MSDN documentation have stuff
like the following in VB programs.

Public Sub X(thing as object)
'/ <summary>
'/ This would describe X
'/ </summary>
'/ <param name=thing>Any object will do.</param>
The C# precompiler must actually generate some xml somewhere. This
psuedo-xml in the C# source code must be converted to something. Is there
any way to generate and embed that "by-hand"? That is, could one generate
one's own and put it where it needs to go? I don't have access to C#, only
to VB.

I don't mind writing the documentation externally from the source code
itself.

You can generate the XML documentation files for VB.NET with XML Documentation Tool.
Look at:
http://www.gotdotnet.com/team/vb/

--
Adam Nowotny
JID: da**@chrome.pl

[Herfried K. Wagner [MVP]]

* Adam Nowotny <ad**@logosoft.pl> scripsit:

You can generate the XML documentation files for VB.NET with XML Documentation Tool.
Look at:
http://www.gotdotnet.com/team/vb/

My link collection:

<http://dotnet.mvps.org/dotnet/code/distributionanddocumentation/>

Just have a look at the links and ignore the text.

--
Herfried K. Wagner [MVP]
<http://dotnet.mvps.org/>

[Cor]

Hi Herfried,

I wrote about the German language about the Benelux and the Scandianavians,
you can add the people from Polen (not from Chicago) and form Tjechie with
that.

:-)

Adam is from Polen,

Cor

[Herfried K. Wagner [MVP]]

* "Cor" <no*@non.com> scripsit:

I wrote about the German language about the Benelux and the Scandianavians,
you can add the people from Polen (not from Chicago) and form Tjechie with
that.

:-)

Adam is from Polen,

:-)

--
Herfried K. Wagner [MVP]
<http://dotnet.mvps.org/>