Skip to content

Latest commit

 

History

History
128 lines (75 loc) · 2.92 KB

File metadata and controls

128 lines (75 loc) · 2.92 KB

DemoClass.Item Indexer

Declaring Type: DemoClass
Namespace: DemoProject
Assembly: DemoProject

Overloads

Signature Description
Item[int, int] An example of an indexer with two parameters.
Item[int] An example of an indexer with a single parameter.
Item[object] An example of an obsolete indexer.

Item[int, int]

An example of an indexer with two parameters.

public string this[int x, int y] { get; }

Parameters

x int

Description of parameter x provided using the param element.

y int

Description of parameter y provided using the param element.

Indexer Value

string

The tag value allows specifying the value a indexer represents

Remarks

Remarks allow specification of more detailed information about a member, in this case the indexer. supplementing the information specified in the summary.

For overloaded members, there is a separate "Remarks" section for every overload.

See Also

Item[int]

An example of an indexer with a single parameter.

public string this[int index] { get; }

Parameters

index int

Description of parameter index provided using the param element.

Indexer Value

string

The tag value allows specifying the value a indexer represents

Remarks

Remarks allow specification of more detailed information about a member, in this case the indexer. supplementing the information specified in the summary.

For overloaded members, there is a separate "Remarks" section for every overload.

Exceptions

ArgumentException

Exceptions can be documented using the exception tag.

InvalidOperationException

Example

Using the example tag, examples on how to call a member can be included in the documentation:

var instance = new DemoClass();
var value = instance[42];

See Also

Item[object]

⚠️ Warning: This indexer is obsolete. Use this[int,int] instead.

An example of an obsolete indexer.

[Obsolete("This indexer is obsolete. Use this[int,int] instead.")]
public string this[object arg] { get; }

Parameters

arg object

Indexer Value

string

Remarks

If a member is marked as obsolete using ObsoleteAttribute a warning is included in the generated documentation. The documentation also includes the message specified for the obsolete attribute.


Documentation generated by MdDocs