Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Javadoc like documentation for C#'s XML comments [closed]

I'm looking for something to turn my C# XML comments into documentation. I don't like CHM's, nor MSDN's look and feel. I love using the javadocs. They're easy to navigate, and everything is accessible. I am looking for a tool I can use to convert the comments in my code to a javadoc like look and feel.

Is there something that does this? I've tried Sandcastle and its various GUI's but they don't do what I want.

like image 926
Malfist Avatar asked May 08 '09 20:05

Malfist


People also ask

Does C++ have a Javadoc?

Does C++ have anything similar to javadoc? Yes. Here are a few (listed alphabetically by tool name): ccdoc supports javadoc-like syntax with various extensions.

Is javadocs a documentation tool?

JavaDoc tool is a document generator tool in Java programming language for generating standard documentation in HTML format. It generates API documentation. It parses the declarations ad documentation in a set of source file describing classes, methods, constructors, and fields.

What is Javadoc style documentation?

Javadoc is a documentation tool which defines a standard format for such comments, and which can generate HTML files to view the documentation from a web broswer. (As an example, see Oracle's Javadoc documentation for the Java libraries at http://download.oracle.com/javase/6/docs/api/.)

How can you generate Javadoc documentation for your code?

Step 1 − Open eclipse, select the option Project →Generate Javadoc. Step 2 − Select the javadoc.exe file from the bin folder of java installation directory, select the destination folder for the generated java doc and select Next. finish button.


2 Answers

Probably you can use Doxygen ?

like image 64
stuartd Avatar answered Oct 31 '22 03:10

stuartd


Please see this question https://stackoverflow.com/questions/546053/anyone-using-ndoc-or-a-similar-tool-to-help-with-system-documentation/ You will find there a brief overview of different commercial and opensource tools

My vote is for SandCastle

like image 42
Bogdan_Ch Avatar answered Oct 31 '22 03:10

Bogdan_Ch