Last active
August 10, 2017 23:08
-
-
Save feliperomero3/8a5da837510ff603bc7ca2cca5b13051 to your computer and use it in GitHub Desktop.
How to use XML comments using C# on Visual Studio (Source: MSDN)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// https://msdn.microsoft.com/en-us/library/z04awywx.aspx | |
// If compiling from the command line, compile with: /doc:YourFileName.xml | |
/// <summary> | |
/// Class level summary documentation goes here.</summary> | |
/// <remarks> | |
/// Longer comments can be associated with a type or member through | |
/// the remarks tag.</remarks> | |
public class TestClass : TestInterface | |
{ | |
/// <summary> | |
/// Store for the name property.</summary> | |
private string _name = null; | |
/// <summary> | |
/// The class constructor. </summary> | |
public TestClass() | |
{ | |
// TODO: Add Constructor Logic here. | |
} | |
/// <summary> | |
/// Name property. </summary> | |
/// <value> | |
/// A value tag is used to describe the property value.</value> | |
public string Name | |
{ | |
get | |
{ | |
if (_name == null) | |
{ | |
throw new System.Exception("Name is null"); | |
} | |
return _name; | |
} | |
} | |
/// <summary> | |
/// Description for SomeMethod.</summary> | |
/// <param name="s"> Parameter description for s goes here.</param> | |
/// <seealso cref="System.String"> | |
/// You can use the cref attribute on any tag to reference a type or member | |
/// and the compiler will check that the reference exists. </seealso> | |
public void SomeMethod(string s) | |
{ | |
} | |
/// <summary> | |
/// Some other method. </summary> | |
/// <returns> | |
/// Return results are described through the returns tag.</returns> | |
/// <seealso cref="SomeMethod(string)"> | |
/// Notice the use of the cref attribute to reference a specific method. </seealso> | |
public int SomeOtherMethod() | |
{ | |
return 0; | |
} | |
public int InterfaceMethod(int n) | |
{ | |
return n * n; | |
} | |
/// <summary> | |
/// The entry point for the application. | |
/// </summary> | |
/// <param name="args"> A list of command line arguments.</param> | |
static int Main(System.String[] args) | |
{ | |
// TODO: Add code to start application here. | |
return 0; | |
} | |
} | |
/// <summary> | |
/// Documentation that describes the interface goes here. | |
/// </summary> | |
/// <remarks> | |
/// Details about the interface go here. | |
/// </remarks> | |
interface TestInterface | |
{ | |
/// <summary> | |
/// Documentation that describes the method goes here. | |
/// </summary> | |
/// <param name="n"> | |
/// Parameter n requires an integer argument. | |
/// </param> | |
/// <returns> | |
/// The method returns an integer. | |
/// </returns> | |
int InterfaceMethod(int n); | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment