469,299 Members | 2,073 Online
Bytes | Developer Community
New Post

Home Posts Topics Members FAQ

Post your question to a community of 469,299 developers. It's quick & easy.

C# XML Documentation Tool

ME
I am trying to find a comprehensive addin for Visual Studio .Net 2003 that
will help with documenting my code. In particular I am looking for a GUI of
some kind that could make it easier (and faster) to supply more complete
comments for multiple comment tags (<summary>, <seealso>, <exception>,
<code>, <see>, etc). Mostly I am trying to find a way to document lines and
lines of code with out having to type the tags, but instead just fill in the
appropriate text in between as necessary.

Does anyone know of any addins or 3rd party tools that could do this?

Thanks,

Matt
Nov 12 '05 #1
3 2327
VS.NET 2005 is quite good at that, isn't it?

just type "///" and zip you have a skeletton.
or type "<s" and it popups a completion box.

or go on the class diagram view, at the bottom you have comment field where
you don't even see the XML!

"ME" <tr*********@comcast.netREMOVETHIS> wrote in message
news:3Z********************@comcast.com...
I am trying to find a comprehensive addin for Visual Studio .Net 2003 that
will help with documenting my code. In particular I am looking for a GUI
of some kind that could make it easier (and faster) to supply more complete
comments for multiple comment tags (<summary>, <seealso>, <exception>,
<code>, <see>, etc). Mostly I am trying to find a way to document lines
and lines of code with out having to type the tags, but instead just fill
in the appropriate text in between as necessary.

Does anyone know of any addins or 3rd party tools that could do this?

Thanks,

Matt

Nov 12 '05 #2
C# supports XML documentation, so you can just type /// above the code
element and the template is inserted.

That said, my add-in (below) allows you to insert customizable headers
(file, class or procedure level) with predefined variables or user-defined
variables. In the later case, a window with textboxes is shown and you only
have to enter the data and click OK.

--

Best regards,

Carlos J. Quintero

MZ-Tools: Productivity add-ins for Visual Studio .NET, VB6, VB5 and VBA
You can code, design and document much faster.
Free resources for add-in developers:
http://www.mztools.com

"ME" <tr*********@comcast.netREMOVETHIS> escribió en el mensaje
news:3Z********************@comcast.com...
I am trying to find a comprehensive addin for Visual Studio .Net 2003 that
will help with documenting my code. In particular I am looking for a GUI
of some kind that could make it easier (and faster) to supply more complete
comments for multiple comment tags (<summary>, <seealso>, <exception>,
<code>, <see>, etc). Mostly I am trying to find a way to document lines
and lines of code with out having to type the tags, but instead just fill
in the appropriate text in between as necessary.

Does anyone know of any addins or 3rd party tools that could do this?

Thanks,

Matt

Nov 12 '05 #3
ME
Just thought others may benifit from this find:

http://www.west-wind.com/wwHelp/download.asp

Thanks,

Matt
"ME" <tr*********@comcast.netREMOVETHIS> wrote in message
news:3Z********************@comcast.com...
I am trying to find a comprehensive addin for Visual Studio .Net 2003 that
will help with documenting my code. In particular I am looking for a GUI
of some kind that could make it easier (and faster) to supply more complete
comments for multiple comment tags (<summary>, <seealso>, <exception>,
<code>, <see>, etc). Mostly I am trying to find a way to document lines
and lines of code with out having to type the tags, but instead just fill
in the appropriate text in between as necessary.

Does anyone know of any addins or 3rd party tools that could do this?

Thanks,

Matt

Nov 12 '05 #4

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

2 posts views Thread by Kalle Anke | last post: by
2 posts views Thread by Andy Meca | last post: by
reply views Thread by jhcorey | last post: by
40 posts views Thread by GTi | last post: by
10 posts views Thread by gzinger | last post: by
10 posts views Thread by Lloyd Dupont | last post: by
5 posts views Thread by Bob Altman | last post: by
1 post views Thread by CARIGAR | last post: by
reply views Thread by harlem98 | last post: by
1 post views Thread by Geralt96 | last post: by
reply views Thread by harlem98 | last post: by
By using this site, you agree to our Privacy Policy and Terms of Use.