SampleClass.SummaryRemarksExample Method

Sandcastle XML Comments

previous page next page
Sandcastle XML Comments GuideSampleClassSummaryRemarksExample Method
The summary is a brief description of the type or type member and will be displayed in IntelliSense and the Object Browser.

Namespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
Copy
public void SummaryRemarksExample()
Public Sub SummaryRemarksExample
public:
void SummaryRemarksExample()
member SummaryRemarksExample : unit -> unit
Remarks
The remarks element should be used to provide more detailed information about the type or member such as how it is used, its processing, etc.

Remarks will only appear in the help file and can be as long as necessary.

See Also
previous page start next page