documentation on how to make documentation  
Author Message
VooDoo Chicken





PostPosted: Visual C# General, documentation on how to make documentation Top

when a new class or something is added to a project, some tags are created, like sumary and stuff, which i believe is part of some kind of documentation standard like javadoc. where can i get info on how to create correct documentation on the classes- members and stuff i create

tnx



Visual C#14  
 
 
ahmedilyas





PostPosted: Visual C# General, documentation on how to make documentation Top

thats Xml documentation/tags

basically on any method for example, place 3 forward slashes and it should produce the tags you are after.

Example on button78_Click, I will place 3 forward slashes at the top of the signature for that method, and it will place this:

/// <summary>

///

/// </summary>

/// <param name="sender"></param>

/// <param name="e"></param>

private void button78_Click(object sender, EventArgs e)

{

}