c

Sandcastle XML Comments

previous page next page
Sandcastle XML Comments Guide c

This element is used to indicate that text within a description should be marked as code.

Syntax

This inline element can be used within any other element.

Copy 
<c>text</c>
Remarks

Use this element to mark inline text as code. Use the code element to mark a multi-line block of lines as code.

Example
Copy 
/// <summary>
/// The <c>Increment</c> method increments the stored number by one
/// </summary>
/// <returns>The new sample number after being incremented</returns>
/// <conceptualLink target="d0db2290-08bb-40cc-9797-23a342b96564" />
/// <conceptualLink target="fa97c10b-a683-4d10-a01c-5787dbdd42d3" />
public int Increment()
{
    return ++this.SampleNumber;
}
See Also

Reference

Increment

Other Resources

Inline Elements
code
previous page start next page