PC Review


Reply
Thread Tools Rate Thread

C# XML Documentation Tool

 
 
ME
Guest
Posts: n/a
 
      22nd Jul 2005
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 With Quote
 
 
 
 
Lloyd Dupont
Guest
Posts: n/a
 
      22nd Jul 2005
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" <(E-Mail Removed)> wrote in message
news:3ZCdnS043KfRFn3fRVn-(E-Mail Removed)...
>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 With Quote
 
Carlos J. Quintero [.NET MVP]
Guest
Posts: n/a
 
      22nd Jul 2005
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" <(E-Mail Removed)> escribió en el mensaje
news:3ZCdnS043KfRFn3fRVn-(E-Mail Removed)...
>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 With Quote
 
ME
Guest
Posts: n/a
 
      31st Jul 2005
Just thought others may benifit from this find:

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

Thanks,

Matt


"ME" <(E-Mail Removed)> wrote in message
news:3ZCdnS043KfRFn3fRVn-(E-Mail Removed)...
>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 With Quote
 
 
 
Reply

Thread Tools
Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
C# XML Documentation Tool ME Microsoft Dot NET 3 31st Jul 2005 06:35 AM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft VB .NET 0 10th Sep 2003 11:26 AM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft Dot NET 0 10th Sep 2003 11:25 AM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft C# .NET 0 10th Sep 2003 11:25 AM
Documentation tool for ADS jo Microsoft Windows 2000 Active Directory 0 3rd Jul 2003 10:07 PM


Features
 

Advertising
 

Newsgroups
 


All times are GMT +1. The time now is 08:59 PM.