CodeVerge.Net Beta
Login Idy
Register Password
  Forgot?
Explore    Item Entry    Members   
NEWSGROUP
.NET
Algorithms-Data Structures
Asp.Net
C Plus Plus
CSharp
Database
HTML
Javascript
Linq
Other
Regular Expressions
VB.Net
XML





Zone: > NEWSGROUP > Asp.Net Forum > visual_studio.visual_studio_2005 Tags:
Item Type: NewsGroup Date Entered: 3/3/2008 4:05:12 PM Date Modified: Subscribers: 0 Subscribe Alert
Rate It:
(NR, 0)
XPoints: N/A Replies: 3 Views: 19 Favorited: 0 Favorite
Can Reply:  No Members Can Edit: No Online: Yes
4 Items, 1 Pages 1 |< << Go >> >|
jmsewe0
Asp.Net User
Triple Slash commenting in C# classes3/3/2008 4:05:12 PM

0/0

Guys, i am working on a pretty large web project for my employer that consists of quite a few C# classes.  We have so many methods, the application is starting to become unruly.  I know C# has the '///' option for commenting these methods, but can anyone suggest a tool that will allow me to use those comments to form some sort of documentation?  One of the guys i work with mentioned ndoc, but apparently that software is no longer being developed.  Any thoughts would be super helpful!  Thanks a ton!

 

-Josh

 

EDIT: I may have answered my own question.  Just found this: http://msdn2.microsoft.com/en-us/magazine/cc302121.aspx

EDIT-AGAIN: Ok, not really what i was looking for.  Anyone have any automated tools that can take the XML and create a help document out of it?
StrongTypes
Asp.Net User
Re: Triple Slash commenting in C# classes3/3/2008 5:31:11 PM

0/0
jmsewe0
Asp.Net User
Re: Triple Slash commenting in C# classes3/4/2008 8:21:00 PM

0/0

Thanks for the quick response.  I downloaded Ghost Doc, and i see what the program does, but is there anything out there that will take those comments are create maybe a .chm file?  Something we give new developers to access while learning the ins and outs of applications? 

 

Thanks again.  josh
rfreeze
Asp.Net User
Re: Triple Slash commenting in C# classes3/4/2008 10:12:55 PM

0/0

wrote in message news:[email protected]...
> Thanks for the quick response. I downloaded Ghost Doc, and i see what the
> program does, but is there anything out there that will take those
> comments are create maybe a .chm file? Something we give new developers
> to access while learning the ins and outs of applications?
>
>


Check out doxygen at:

http://www.stack.nl/~dimitri/doxygen/


Output Formats
The following output formats are directly supported by doxygen:
---
Compiled HTML Help (a.k.a. Windows 98 help)
Generated by Microsoft's HTML Help workshop from the HTML output if
GENERATE_HTMLHELP is set to YES.
---
HTML
Generated if GENERATE_HTML is set to YES in the configuration file.

Generated if GENERATE_LATEX is set to YES in the configuration file.
Man pages
Generated if GENERATE_MAN is set to YES in the configuration file.
RTF
Generated if GENERATE_RTF is set to YES in the configuration file.
Note that the RTF output probably only looks nice with Microsoft's Word 97.
If you have success with other programs, please let me know.
XML
Generated if GENERATE_XML is set to YES in the configuration file.
Note that the XML output is still under development.
The following output formats are indirectly supported by doxygen:
Compiled HTML Help (a.k.a. Windows 98 help)
Generated by Microsoft's HTML Help workshop from the HTML output if
GENERATE_HTMLHELP is set to YES.
PostScript
Generated from the output by running make ps in the output directory. For
the best results PDF_HYPERLINKS should be set to NO.
PDF
Generated from the output by running make pdf in the output directory. To
improve the PDF output, you typically would want to enable the use of
pdflatex by setting USE_PDFLATEX to YES in the configuration file. In order
to get hyperlinks in the PDF file you also need to enable PDF_HYPERLINKS.
--
BobF
4 Items, 1 Pages 1 |< << Go >> >|



Search This Site:


Meet Our Sponsors:



Other Resources:

[LINKS] module whitespace? - starter_kits_and_source_projects ... <a class="SkinObject" href="/Testing/Main Site Test/Architects/tabid/55/Default. ... triple slash commenting in c# classes. deploying login control to server ...
Can GroupWise read a p7m file? - novell.support.groupwise.6x.clients - Web Programming Newsgroups Can GroupWise read a p7m file?, > ROOT > NEWSGROUP > Novell Forums > novell. ... triple slash commenting in c# classes. how to use profile in class library ...
Commenting is Easy! " Kyle Schouviller ... I started using C# and discovered the joy of commenting in Visual Studio 2005 ... This ease and usefulness are all wrapped up in the triple-slash, ...
DevelopmentNow - NaturalDocs ... XML (triple-slash) comments, and it seemed to miss a number of my classes (I ... triple-slash comments & partial classes then it might be more useful for C# etc ...
Re Converting Objective C to C# ... NSLog and -(NSString *)description C# comments are inserted - the triple slash, ... namespaces, classes and methods Original comments are retained in the C# code ...
InformIT: Getting Started with C# > Comments 6: // Program start class 7: public class HowdyPartner 8: { 9: ... XML documentation comments start with a triple slash, ///. Comments are enclosed in XML tags. ...
Feedback: Allow automatic documentation generation as in C# In C# you can use the triple slash (///) to create documentation. This does not work in VB.Net. Comments ... able to generate class documentation automatically. ...
 
All Times Are GMT