<returns> (JavaScript)

Gibt Dokumentationsinformationen für das Ergebnis einer Funktion oder eines Methodenaufrufs an.

<returns type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" value="code">description</returns>

Parameter

• type
  Dies ist optional.Der Datentyp des Rückgabewerts.Der Typ sind zulässig:

  • Eine ECMAScript-Sprache geben die Spezifikation ECMAScript 5, wie Number und Object ein.

  • Ein DOM-Objekt, wie HTMLElement, Window und Document.

  • Eine JavaScript-Konstruktorfunktion.

• integer
  Dies ist optional.Wenn typeNumber ist, gibt an, ob der Rückgabewert eine ganze Zahl ist.Legen Sie auf true, anzugeben, dass der Rückgabewert eine ganze Zahl ist, Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.

• domElement
  Dies ist optional.Dieses Attribut ist veraltet; type das Attribut hat Vorrang vor diesem Attribut.Dieses Attribut gibt an, ob der dokumentierte Rückgabewert ein DOM-Element ist.Legen Sie auf true, anzugeben, dass der Rückgabewert ein DOM-Element ist; Wird andernfalls zu false.Wenn das Attribut nicht type festgelegt ist und domElement zu true festgelegt wird, behandelt IntelliSense den dokumentierten Rückgabewert als HTMLElement, wenn Anweisungsvervollständigung ausführt.

• mayBeNull
  Dies ist optional.Gibt an, ob der dokumentierte Rückgabewert festgelegt werden kann, um ungültig zu machen.Legen Sie auf true, anzugeben, dass der Rückgabewert festgelegt werden kann, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.

• elementType
  Dies ist optional.Wenn typeArray ist, gibt dieses Attribut den Typ der Elemente im Array an.

• elementInteger
  Dies ist optional.Wenn typeArray ist und elementTypeNumber ist, gibt dieses Attribut an, ob die Elemente im Array ganze Zahlen sind.Legen Sie auf true, anzugeben, dass die Elemente im Array ganze Zahlen sind; Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.

• elementDomElement
  Dies ist optional.Dieses Attribut ist veraltet; elementType das Attribut hat Vorrang vor diesem Attribut.Wenn typeArray ist, gibt dieses Attribut an, ob die Elemente im Array DOM-Elemente sind.Legen Sie auf true, anzugeben, dass die Elemente DOM-Elemente sind; Wird andernfalls zu false.Wenn das Attribut nicht elementType festgelegt ist und elementDomElement zu true festgelegt wird, behandelt IntelliSense jedes Element im Array als HTMLElement, wenn Anweisungsvervollständigung ausführt.

• elementMayBeNull
  Dies ist optional.Wenn typeArray ist, gibt an, ob die Elemente im Array festgelegt werden können, um ungültig zu machen.Legen Sie auf true, anzugeben, dass die Elemente im Array festgelegt werden können, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.

• locid
  Dies ist optional.Der Bezeichner für Lokalisierungsinformation über den Rückgabewert.Der Bezeichner ist entweder eine Member ID, oder sie entspricht dem name-Attributwert in einem Meldungsbündel, das von OpenAjax-Metadaten definiert ist.Der Bezeichnertyp hängt vom Format ab, das im <loc> (JavaScript)-Tag angegeben wird.

• value
  Dies ist optional.Gibt Code an, der für IntelliSense anstelle des Funktionscodes ausgewertet werden sollte selbst.Beispielsweise können Sie dieses Attribut verwenden, um IntelliSense für asynchrone Rückrufe, wie Promise bereitzustellen.Verwenden des value-Attributs mit dem <returns>-Element kann IntelliSense-Leistung durch Umgehung der längeren Codeausführung verbessern.

• description
  Dies ist optional.Eine Beschreibung des Rückgabewerts.

Hinweise

Das <returns>-Element muss in den Funktionsrumpf vor allen Anweisungen eingefügt werden.

Beispiel

Das folgende Codebeispiel zeigt, wie das <returns>-Element verwendet.

function areaFunction(radiusParam)
{
    /// <summary>Determines the area of a circle when provided a radius parameter.</summary>
    /// <param name="radius" type="Number">The radius of the circle.</param>
    /// <returns type="Number">The area.</returns>
    var areaVal;
    areaVal = Math.PI * radiusParam * radiusParam;
    return areaVal;
}

// The following examples use the <remarks> element with a value attribute.

function getJson(complete) { 
    /// <returns value='complete("")' ></returns>
    var r = new XMLHttpRequest(); 
    // . . . 
} 

getJson(function (json) { 
    json.  // IntelliSense for a String object is 
           // available here.
});

function calculate(x) {
    /// <returns value='1'/>
}
calculate().  // Completion list for a Number.

Siehe auch

Konzepte

XML-Dokumentationskommentare (JavaScript)