473,395 Members | 1,692 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,395 software developers and data experts.

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 2440
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 thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
by: Kalle Anke | last post by:
I'm confused of how I should document my code, I've always liked being able to document my code directly in my source file and then to use some tool to extract the documentation to some other...
2
by: Andy Meca | last post by:
I wrote a component library in C#. Is there a tool that will generate documentation for me which looks exactly like the Microsoft .NET framework documentation? I saw a third party component...
0
by: Gerard Brazil | last post by:
I've been trying to use the Visual Basic .NET XML Documentation Tool to document a project of mine and it's been a VERY frustrating and unproductive endeavor. First off, I can't even load my...
0
by: jhcorey | last post by:
I recently saw an example of Conceptual/Logical/Physical documentation done as web pages, with links to related items. There might be a page devoted to an application screen, which would include a...
40
by: GTi | last post by:
Is there any source code documentation tools available for Visual Studio 2005 ? I have created a LIB that must be documented. Must I do it by hand or is it some kind of tools to pre document my...
10
by: gzinger | last post by:
Since I never seen the following question answered, I am re-posting it: Hi Im using ASP.NET 2 with C# in codebehind files and Visual Studio 2005 Team Edition. I have embedded lots of XML...
0
by: innovasys | last post by:
TORQUAY, DEVON, UK - Innovasys announced the release of Document! X 5, the fifth version of the documentation solution of choice for developers using Microsoft Visual Studio or the .NET Framework....
10
by: Lloyd Dupont | last post by:
Let say I have 2 methods: void BeginGroup(); void BeginGroup(string msg); when I want to refer to them I write /// <see cref="BeginGroup"/> But this cause a compiler warning, where my...
5
by: Bob Altman | last post by:
I thought I read somewhere in the MS documentation that XML documentation is compiled in C++, but the C++ code editor obviously doesn't do anything interesting when I enter "///". What's the deal...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.