X hits on this document

1005 views

0 shares

0 downloads

0 comments

354 / 396

Appendix ‎A   Documentation comments

A.2.11

<remarks>

This tag is used to specify overview information about a type. (Use <summary>‎A.2.15) to describe the members of a type.)

Syntax:

<remarks>description</remarks>

where

description

The text of the remarks.

Example:

/// <remarks>Class <c>Point</c> models a point in a /// two-dimensional plane.</remarks> public class Point { // ... }

A.2.12

<returns>

This tag is used to describe the return value of a method.

Syntax:

<returns>description</returns>

where

description

A description of the return value.

Example:

/// <summary>Report a point's location as a string.</summary> /// <returns>A string representing a point's location, in the form (x,y), ///without any leading, trailing, or embedded whitespace.</returns> public override string ToString() { return "(" + X + "," + Y + ")"; }

A.2.13

<see>

This tag allows a link to be specified within text. Use <seealso>‎A.2.14) to indicate text that is to appear in a See Also section.

Syntax:

<see cref="member"/>

where

cref="member"

The name of a member. The documentation generator checks that the given code element exists and changes member to the element name in the generated documentation file.

Example:

Copyright Microsoft Corporation 1999-2003. All Rights Reserved.341

Document info
Document views1005
Page views1005
Page last viewedFri Dec 09 13:59:08 UTC 2016
Pages396
Paragraphs9401
Words133190

Comments