Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

"javadoc" in C#

Tags:

I have been looking online to find out how to "javadoc" in C# console application. All the articles refer to a webform of C# in the case for that, /// would be the javadoc. What is the way to do it if you are making a console application in visual studio?

Edit: I remember it had to deal with a @ before the method

like image 257
haysam Avatar asked Jun 10 '13 14:06

haysam


People also ask

Is there a javadoc for C?

There are several tools that works like JavaDoc for C++ The most popular tool is probably doxygen. It can handle JavaDoc-like comments, and also several languages (e.g., C++, C, Java, Objective-C, Python, PHP, C#).

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.

What is the use of javadoc?

Javadoc is a tool for generating API documentation in HTML format from doc comments in source code. It can be downloaded only as part of the Java 2 SDK. To see documentation generated by the Javadoc tool, go to J2SE 1.5. 0 API Documentation.

What is meant by javadoc?

Javadoc (originally cased JavaDoc) is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code.


1 Answers

Three forward slashes begins the doc:

/// <summary> /// My method does stuff. /// </summary> public void MyMethod() { ... } 

Then, you can modify the project properties to output XML files that contain the documentation for other developers, or use an application like SandCastle to generate full-fledged documentation web pages.

like image 189
Haney Avatar answered Sep 28 '22 01:09

Haney