The <overloads> tag specifies a summary, remarks and examples common to all overloads of a member. This information will appear on the Overloads topic page and on Members list topic page.
Only one overload should specify this tag. If it's specified in several overloads, the random one will be chosen. Two forms of this tag are available. The short form only contains common summary text for all overloads. It will appear on the Overloads topic page and on Members list topic page. In expanded form, you can add two more tags inside it - remarks and example. This information will appear on the Overloads topic page.
Syntax
Short form:
<overloads>summary_text</overloads>
Expanded form:
<overloads>
<summary>summary_text</summary>
[<remarks>remarks_text</remarks>]
[<example>example_text</example>]
</overloads>
Short form:
Visual Basic
|
 Copy Code
|
''' <summary>Our sample method with parameter.</summary>
''' <param name="x">The first parameter.</param>
''' <overloads>
''' Common summary. This method has two overloads.
''' </overloads>
Sub method1(ByVal x As Integer)
''' <summary>Our sample method without parameter.</summary>
Sub method1()
|
C#
|
Copy Code
|
/// <summary>Our sample method with parameter.</summary>
/// <param name="x">The first parameter.</param>
/// <overloads>
/// Common summary. This method has two overloads.
/// </overloads>
public void method1(int x)
/// <summary>Our sample method without parameter.</summary>
public void method1()
|
Expanded form:
Visual Basic
|
Copy Code
|
''' <summary>Our sample method with parameter.</summary>
''' <param name="x">The first parameter.</param>
''' <remarks>Remarks text just for this overload with one parameter.</remarks>
''' <overloads>
''' <summary>
''' Common summary. This method has two overloads.
''' </summary>
''' <remarks>
''' Common remarks text.
''' </remarks>
''' <example>
''' Common example text.
''' </example>
''' </overloads>
Sub method1(ByVal x As Integer)
''' <summary>Our sample method without parameter.</summary>
Sub method1()
|
C#
|
Copy Code
|
/// <summary>Our sample method with parameter.</summary>
/// <param name="x">The first parameter.</param>
/// <overloads>
/// <summary>
/// Common summary. This method has two overloads.
/// </summary>
/// <remarks>
/// Common remarks text.
/// </remarks>
/// <example>
/// Common example text.
/// </example>
/// </overloads>
public void method1(int x)
/// <summary>Our sample method without parameter.</summary>
public void method1()
|
|
Examples