Hi,

I know there is an autodocument feature in C# which translates in-code
comments and parameterinformation, etc... into xml documentation. Ideal
stuff for documenting a framework.

Does such a tool exist for vb.net as wel?

i'd appreciate all help on this topic!

Bonna

Re: autodoc feature in vb.net? by Jan

Jan
Thu Jan 08 03:28:35 CST 2004

Check out the PowerToys:
http://www.gotdotnet.com/team/ide/
VB Commenter

Adding comments to your Visual Basic source code has never been easier.
After installing this PowerToy, you can type ''' followed by Enter in the VB
code editor and the appropriate XML-style comment tags will appear. You can
even create an XML file of all comments in a given class library, ready to
use with the Custom Help Builder PowerToy. Now you can quickly create a
professional help package to support your Visual Basic solution.



To create docs, I suggest NDoc:

http://ndoc.sourceforge.net/

NDoc generates class libraries documentation from .NET assemblies and the
XML documentation files generated by the C# compiler (or an add-on tool for
VB.NET).


--
Greetz

Jan Tielens
________________________________
Read my weblog: http://weblogs.asp.net/jan


"Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
news:3ffd1b5e$0$331$e4fe514c@news.xs4all.nl...
> Hi,
>
> I know there is an autodocument feature in C# which translates in-code
> comments and parameterinformation, etc... into xml documentation. Ideal
> stuff for documenting a framework.
>
> Does such a tool exist for vb.net as wel?
>
> i'd appreciate all help on this topic!
>
> Bonna
>
>



Re: autodoc feature in vb.net? by Bonna

Bonna
Thu Jan 08 07:29:09 CST 2004

Just the stuff I was looking for! Thx!

"Jan Tielens" <jan@no.spam.please.leadit.be> wrote in message
news:#8jfLnc1DHA.2544@TK2MSFTNGP10.phx.gbl...
> Check out the PowerToys:
> http://www.gotdotnet.com/team/ide/
> VB Commenter
>
> Adding comments to your Visual Basic source code has never been easier.
> After installing this PowerToy, you can type ''' followed by Enter in the
VB
> code editor and the appropriate XML-style comment tags will appear. You
can
> even create an XML file of all comments in a given class library, ready to
> use with the Custom Help Builder PowerToy. Now you can quickly create a
> professional help package to support your Visual Basic solution.
>
>
>
> To create docs, I suggest NDoc:
>
> http://ndoc.sourceforge.net/
>
> NDoc generates class libraries documentation from .NET assemblies and the
> XML documentation files generated by the C# compiler (or an add-on tool
for
> VB.NET).
>
>
> --
> Greetz
>
> Jan Tielens
> ________________________________
> Read my weblog: http://weblogs.asp.net/jan
>
>
> "Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
> news:3ffd1b5e$0$331$e4fe514c@news.xs4all.nl...
> > Hi,
> >
> > I know there is an autodocument feature in C# which translates in-code
> > comments and parameterinformation, etc... into xml documentation. Ideal
> > stuff for documenting a framework.
> >
> > Does such a tool exist for vb.net as wel?
> >
> > i'd appreciate all help on this topic!
> >
> > Bonna
> >
> >
>
>



Re: autodoc feature in vb.net? by Bonna

Bonna
Thu Jan 08 09:42:24 CST 2004

After installing and using it however...

It only creates the xml-files for the main-project while it excludes the
other project directories...:(
very annoying!


"Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
news:3ffd5ab0$0$326$e4fe514c@news.xs4all.nl...
> Just the stuff I was looking for! Thx!
>
> "Jan Tielens" <jan@no.spam.please.leadit.be> wrote in message
> news:#8jfLnc1DHA.2544@TK2MSFTNGP10.phx.gbl...
> > Check out the PowerToys:
> > http://www.gotdotnet.com/team/ide/
> > VB Commenter
> >
> > Adding comments to your Visual Basic source code has never been easier.
> > After installing this PowerToy, you can type ''' followed by Enter in
the
> VB
> > code editor and the appropriate XML-style comment tags will appear. You
> can
> > even create an XML file of all comments in a given class library, ready
to
> > use with the Custom Help Builder PowerToy. Now you can quickly create a
> > professional help package to support your Visual Basic solution.
> >
> >
> >
> > To create docs, I suggest NDoc:
> >
> > http://ndoc.sourceforge.net/
> >
> > NDoc generates class libraries documentation from .NET assemblies and
the
> > XML documentation files generated by the C# compiler (or an add-on tool
> for
> > VB.NET).
> >
> >
> > --
> > Greetz
> >
> > Jan Tielens
> > ________________________________
> > Read my weblog: http://weblogs.asp.net/jan
> >
> >
> > "Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
> > news:3ffd1b5e$0$331$e4fe514c@news.xs4all.nl...
> > > Hi,
> > >
> > > I know there is an autodocument feature in C# which translates in-code
> > > comments and parameterinformation, etc... into xml documentation.
Ideal
> > > stuff for documenting a framework.
> > >
> > > Does such a tool exist for vb.net as wel?
> > >
> > > i'd appreciate all help on this topic!
> > >
> > > Bonna
> > >
> > >
> >
> >
>
>



Re: autodoc feature in vb.net? by CJ

CJ
Thu Jan 08 09:43:00 CST 2004

No it doesn't.

"Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
news:3ffd79eb$0$332$e4fe514c@news.xs4all.nl...
> After installing and using it however...
>
> It only creates the xml-files for the main-project while it excludes the
> other project directories...:(
> very annoying!
>
>
> "Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
> news:3ffd5ab0$0$326$e4fe514c@news.xs4all.nl...
> > Just the stuff I was looking for! Thx!
> >
> > "Jan Tielens" <jan@no.spam.please.leadit.be> wrote in message
> > news:#8jfLnc1DHA.2544@TK2MSFTNGP10.phx.gbl...
> > > Check out the PowerToys:
> > > http://www.gotdotnet.com/team/ide/
> > > VB Commenter
> > >
> > > Adding comments to your Visual Basic source code has never been
easier.
> > > After installing this PowerToy, you can type ''' followed by Enter in
> the
> > VB
> > > code editor and the appropriate XML-style comment tags will appear.
You
> > can
> > > even create an XML file of all comments in a given class library,
ready
> to
> > > use with the Custom Help Builder PowerToy. Now you can quickly create
a
> > > professional help package to support your Visual Basic solution.
> > >
> > >
> > >
> > > To create docs, I suggest NDoc:
> > >
> > > http://ndoc.sourceforge.net/
> > >
> > > NDoc generates class libraries documentation from .NET assemblies and
> the
> > > XML documentation files generated by the C# compiler (or an add-on
tool
> > for
> > > VB.NET).
> > >
> > >
> > > --
> > > Greetz
> > >
> > > Jan Tielens
> > > ________________________________
> > > Read my weblog: http://weblogs.asp.net/jan
> > >
> > >
> > > "Bonna" <dbonnevalleREMOVE@hotmail.com> wrote in message
> > > news:3ffd1b5e$0$331$e4fe514c@news.xs4all.nl...
> > > > Hi,
> > > >
> > > > I know there is an autodocument feature in C# which translates
in-code
> > > > comments and parameterinformation, etc... into xml documentation.
> Ideal
> > > > stuff for documenting a framework.
> > > >
> > > > Does such a tool exist for vb.net as wel?
> > > >
> > > > i'd appreciate all help on this topic!
> > > >
> > > > Bonna
> > > >
> > > >
> > >
> > >
> >
> >
>
>



Re: autodoc feature in vb.net? by hirf-spam-me-here

hirf-spam-me-here
Thu Jan 08 12:15:46 CST 2004

* "Bonna" <dbonnevalleREMOVE@hotmail.com> scripsit:
> I know there is an autodocument feature in C# which translates in-code
> comments and parameterinformation, etc... into xml documentation. Ideal
> stuff for documenting a framework.

For VB.NET 2002/2003:

My XML Comments FAQ:

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

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

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

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

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

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

XML comments will be introduced to VB.NET in version 2004.

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