Documentation of Objects

[Mike Morse]

Dies anyone know of a good way to document your classes.
I currently use the VB commenter for VS.net 2003 but that
does not provide any intellisence functionality for my
objects like description and such. Also when you select
tools > build comment web pages... I find these web pages
to be almost useless and less than satisfactory as
documentation.

I would really like to know how to document my objects
better.

Thanks All!

-mike

[Kevin Spencer]

Use C#, and Summary Tags.

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
[url]http://www.takempis.com[/url]
Big things are made up of
lots of little things.

"Mike Morse" <mike.morse@micromo.com> wrote in message
news:001b01c3514b$7dd8c0a0$a501280a@phx.gbl...

> Dies anyone know of a good way to document your classes.
> I currently use the VB commenter for VS.net 2003 but that
> does not provide any intellisence functionality for my
> objects like description and such. Also when you select
> tools > build comment web pages... I find these web pages
> to be almost useless and less than satisfactory as
> documentation.
>
> I would really like to know how to document my objects
> better.
>
> Thanks All!
>
> -mike

[Kevin Spencer]

In that case, wait until MS provides Summary Tags for VB.Net.

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
[url]http://www.takempis.com[/url]
Big things are made up of
lots of little things.

"mike morse" <mike.morse@micromo.com> wrote in message
news:01f301c35153$b741e3f0$a401280a@phx.gbl...

> Your f'n kiddig me. Yeah, why don't I just switch
> languages.
>

> >-----Original Message-----
> >Use C#, and Summary Tags.
> >
> >--
> >HTH,
> >
> >Kevin Spencer
> >Microsoft MVP
> >..Net Developer
> >[url]http://www.takempis.com[/url]
> >Big things are made up of
> >lots of little things.
> >
> >"Mike Morse" <mike.morse@micromo.com> wrote in message
> >news:001b01c3514b$7dd8c0a0$a501280a@phx.gbl...

> >> Dies anyone know of a good way to document your classes.
> >> I currently use the VB commenter for VS.net 2003 but

> that

> >> does not provide any intellisence functionality for my
> >> objects like description and such. Also when you select
> >> tools > build comment web pages... I find these web

> pages

> >> to be almost useless and less than satisfactory as
> >> documentation.
> >>
> >> I would really like to know how to document my objects
> >> better.
> >>
> >> Thanks All!
> >>
> >> -mike

> >
> >
> >.
> >

[Bill Priess]

LOL.. to think, I was going to make the same suggestion...

Mike, unfortunatly, unless you use a VS.NET addin, you are not going to get
much use out of VB's meager commenting features. At least, not like you
would with C# and it's XML Documentation. I have seen one commenter that is
nice, but a bit pricey. CodeSmart for VS.NET ([url]http://www.axtools.com/[/url]).

Anyhow,

HTH,

Bill Priess

On Wed, 23 Jul 2003 12:50:49 -0700, mike morse <mike.morse@micromo.com>
wrote:

> Your f'n kiddig me. Yeah, why don't I just switch languages.
>

>> -----Original Message-----
>> Use C#, and Summary Tags.
>>
>> -- HTH,
>>
>> Kevin Spencer
>> Microsoft MVP
>> ..Net Developer
>> [url]http://www.takempis.com[/url]
>> Big things are made up of
>> lots of little things.
>>
>> "Mike Morse" <mike.morse@micromo.com> wrote in message
>> news:001b01c3514b$7dd8c0a0$a501280a@phx.gbl...

>>> Dies anyone know of a good way to document your classes.
>>> I currently use the VB commenter for VS.net 2003 but

> that

>>> does not provide any intellisence functionality for my
>>> objects like description and such. Also when you select
>>> tools > build comment web pages... I find these web

> pages

>>> to be almost useless and less than satisfactory as
>>> documentation.
>>>
>>> I would really like to know how to document my objects
>>> better.
>>>
>>> Thanks All!
>>>
>>> -mike

>>
>>
>> .
>>

>

--
Using M2, Opera's revolutionary e-mail client: [url]http://www.opera.com/m2/[/url]

[Yan-Hong Huang[MSFT]]

Hello Mike,

XML comments is only supported in C# now. Please refer to
[url]http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/default.aspx[/url] for details.

If you want to do it in other languages, I think you need to install some third party add-in or etc.

Thanks.

Best regards,
Yanhong Huang
Microsoft Online Partner Support

Get Secure! - [url]www.microsoft.com/security[/url]
This posting is provided "AS IS" with no warranties, and confers no rights.

--------------------
!Content-Class: urn:content-classes:message
!From: "mike morse" <mike.morse@micromo.com>
!Sender: "mike morse" <mike.morse@micromo.com>
!References: <001b01c3514b$7dd8c0a0$a501280a@phx.gbl> <u$VS$9UUDHA.556@TK2MSFTNGP12.phx.gbl>
!Subject: Re: Documentation of Objects
!Date: Wed, 23 Jul 2003 12:50:49 -0700
!Lines: 38
!Message-ID: <01f301c35153$b741e3f0$a401280a@phx.gbl>
!MIME-Version: 1.0
!Content-Type: text/plain;
! charset="iso-8859-1"
!Content-Transfer-Encoding: 7bit
!X-Newsreader: Microsoft CDO for Windows 2000
!X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4910.0300
!Thread-Index: AcNRU7dB1HNJBzx5SaqeosxcsVGJ/Q==
!Newsgroups: microsoft.public.dotnet.framework.aspnet
!Path: cpmsftngxa06.phx.gbl
!Xref: cpmsftngxa06.phx.gbl microsoft.public.dotnet.framework.aspnet:161501
!NNTP-Posting-Host: TK2MSFTNGXA12 10.40.1.164
!X-Tomcat-NG: microsoft.public.dotnet.framework.aspnet
!
!Your f'n kiddig me. Yeah, why don't I just switch
!languages.
!
!>-----Original Message-----
!>Use C#, and Summary Tags.
!>
!>--
!>HTH,
!>
!>Kevin Spencer
!>Microsoft MVP
!>..Net Developer
!>[url]http://www.takempis.com[/url]
!>Big things are made up of
!>lots of little things.
!>
!>"Mike Morse" <mike.morse@micromo.com> wrote in message
!>news:001b01c3514b$7dd8c0a0$a501280a@phx.gbl...
!>> Dies anyone know of a good way to document your classes.
!>> I currently use the VB commenter for VS.net 2003 but
!that
!>> does not provide any intellisence functionality for my
!>> objects like description and such. Also when you select
!>> tools > build comment web pages... I find these web
!pages
!>> to be almost useless and less than satisfactory as
!>> documentation.
!>>
!>> I would really like to know how to document my objects
!>> better.
!>>
!>> Thanks All!
!>>
!>> -mike
!>
!>
!>.
!>
!