PC Review


Reply
Thread Tools Rate Thread

creating code reports

 
 
Ohad Young
Guest
Posts: n/a
 
      7th Jan 2004
Hi,

I'm trying to document my code written in VS.NET 2003 using C#.
I'm using the Xml documentation following the recommendations found
in MSDN's "Recommended Tags for Documentation Comments".
When generating the comment web pages using the option
"Build comment web pages..." in the Tools menu the result is far from being
satisfactory. Some of the documentation is missing or, for example:
<exception>, <see> and <list> tags are not interpreted.
In addition, the private members (fields, methods, etc.) appears in the
comment web pages and there is no tag to hide them.

How cam I generate a more comprehensive documentation, like JavaDoc, using
VS.NET?
Is there an alternative freeware tool to document my code?

Thanks in advance, Ohad
--
Ohad Young
Medical Informatics Research Center
Ben Gurion University
Information System Eng
Office Phone: 972-8-6477160
Cellular Phone: 972-54-518301
E-Mail: (E-Mail Removed)


 
Reply With Quote
 
 
 
 
Fons Sonnemans
Guest
Posts: n/a
 
      7th Jan 2004
Hi,

Yes there is! It is called NDoc.

Have a look at:
http://ndoc.sf.net/
http://www.reflectionit.nl/NDoc.aspx

Regards,

Fons

>-----Original Message-----
>Hi,
>
>I'm trying to document my code written in VS.NET 2003

using C#.
>I'm using the Xml documentation following the

recommendations found
>in MSDN's "Recommended Tags for Documentation Comments".
>When generating the comment web pages using the option
>"Build comment web pages..." in the Tools menu the result

is far from being
>satisfactory. Some of the documentation is missing or,

for example:
><exception>, <see> and <list> tags are not interpreted.
>In addition, the private members (fields, methods, etc.)

appears in the
>comment web pages and there is no tag to hide them.
>
>How cam I generate a more comprehensive documentation,

like JavaDoc, using
>VS.NET?
>Is there an alternative freeware tool to document my code?
>
>Thanks in advance, Ohad
>--
>Ohad Young
>Medical Informatics Research Center
>Ben Gurion University
>Information System Eng
>Office Phone: 972-8-6477160
>Cellular Phone: 972-54-518301
>E-Mail: (E-Mail Removed)
>
>
>.
>

 
Reply With Quote
 
Ohad Young
Guest
Posts: n/a
 
      7th Jan 2004
Hi,

I checked NDoc as you suggested and the results are amazing. Great work
by NDoc developers

Thanks for the tip, Ohad


*** Sent via Developersdex http://www.developersdex.com ***
Don't just participate in USENET...get rewarded for it!
 
Reply With Quote
 
 
 
Reply

« Shelling? | Logging »
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
Creating excel file, adding code to it from code, VBE window stays BlueWolverine Microsoft Excel Programming 0 5th Nov 2009 07:55 PM
Creating reports =?Utf-8?B?SnVkeVQ=?= Microsoft Access Getting Started 2 8th Feb 2006 01:57 PM
Creating Reports =?Utf-8?B?RGF2aWQ=?= Microsoft Access Reports 2 3rd Nov 2005 04:18 AM
Creating reports in VB code Max Moor Microsoft Access Reports 5 24th Oct 2003 04:41 PM
Creating new reports John Microsoft Access Reports 0 18th Jul 2003 07:10 PM


Features
 

Advertising
 

Newsgroups
 


All times are GMT +1. The time now is 05:58 AM.