Class level summary documentation goes here.Longer comments can be associated with a type or member through the remarks tag.
string | _name |
---|---|
Store for the name property. |
string | Name |
---|---|
Name property. |
public | TestClass () | |
---|---|---|
The class constructor. | ||
public | void | SomeMethod (string s, int x) |
Description for SomeMethod. | ||
public | int | SomeOtherMethod () |
Some other method. | ||
public | int | InterfaceMethod (int n) |
Documentation that describes the method goes here. |
private | int | Main (System.String[] args) |
---|---|---|
The entry point for the application. |
string TestClass._name | |
---|---|
Store for the name property. |
int TestClass.InterfaceMethod | (int n) |
---|---|
Documentation that describes the method goes here. | |
n | Parameter n requires an integer argument. |
return | The method returns an integer. |
static int TestClass.Main | (System.String[] args) |
---|---|
The entry point for the application. | |
args | A list of command line arguments. |
string TestClass.Name | |
---|---|
Name property. | |
A value tag is used to describe the property value. |
void TestClass.SomeMethod | (string s, int x) |
---|---|
Description for SomeMethod. | |
s | Parameter description for s goes here. |
x | Extra parameter. |
see | 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. |
int TestClass.SomeOtherMethod | () |
---|---|
Some other method. | |
return | Return results are described through the returns tag. |
see | SomeMethod(string) |
Notice the use of the cref attribute to reference a specific method. |
Documentation that describes the interface goes here.Details about the interface go here.
public | int | InterfaceMethod (int n) |
---|---|---|
Documentation that describes the method goes here. |
int TestInterface.InterfaceMethod | (int n) |
---|---|
Documentation that describes the method goes here. | |
n | Parameter n requires an integer argument. |
return | The method returns an integer. |
Location: /Cdoc/TestClass.cs