My Test Project
Public Member Functions | Properties | List of all members
TestClass Class Reference

Class level summary documentation goes here. More...

Inherits TestInterface.

Public Member Functions

 TestClass ()
 The class constructor. More...
 
void SomeMethod (string s, int x)
 Description for SomeMethod. More...
 
int SomeOtherMethod ()
 Some other method. More...
 
int InterfaceMethod (int n)
 Documentation that describes the method goes here. More...
 

Properties

string Name [get]
 Name property. More...
 

Detailed Description

Class level summary documentation goes here.

Longer comments can be associated with a type or member through the remarks tag.

Constructor & Destructor Documentation

TestClass.TestClass ( )

The class constructor.

Member Function Documentation

int TestClass.InterfaceMethod ( int  n)

Documentation that describes the method goes here.

Parameters
nParameter n requires an integer argument.
Returns
The method returns an integer.

Implements TestInterface.

void TestClass.SomeMethod ( string  s,
int  x 
)

Description for SomeMethod.

Parameters
sParameter description for s goes here.
xExtra parameter.
See also
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.

Returns
Return results are described through the returns tag.
See also
SomeMethod(string)

Notice the use of the cref attribute to reference a specific method.

Property Documentation

string TestClass.Name
get

Name property.

A value tag is used to describe the property value.


The documentation for this class was generated from the following file: