CODEWITHSUNDEEP
c#documentationjavadoc
haysam
haysam

Reputation: 441

"javadoc" in C#

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

Upvotes: 30

Views: 29365

Answers (1)

Haney
Haney

Reputation: 34762

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.

Upvotes: 38

Related Questions