C# XML Documentation Tool

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

ME - 22 Jul 2005 06:59 GMT

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

Reply to this Message

Lloyd Dupont - 22 Jul 2005 08:25 GMT

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!

>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
[quoted text clipped - 9 lines]
>
> Matt

Reply to this Message

Carlos J. Quintero [.NET MVP] - 22 Jul 2005 10:01 GMT

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.

Signature

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

>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
[quoted text clipped - 9 lines]
>
> Matt

Reply to this Message

ME - 31 Jul 2005 06:35 GMT

Just thought others may benifit from this find:

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

Thanks,

Matt

>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
[quoted text clipped - 9 lines]
>
> Matt

Reply to this Message

C# XML Documentation Tool

Free Magazines