<returns> (JavaScript)

Určuje informace o dokumentaci pro výsledek volání funkce nebo metody.

<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>

Parametry

• type
  Nepovinné.Datový typ vrácené hodnoty.Typ může být některý z následujících:

  • Zadejte jazyka ECMAScript specifikace ECMAScript 5 jako Number a Object.

  • A DOM object, such as HTMLElement, Window, and Document.

  • Funkce konstruktoru jazyka JavaScript.

• integer
  Nepovinné.Pokud type je Number, určuje, zda je vrácená hodnota je celé číslo.Nastavit true že vrácená hodnota je celé číslo; jinak nastavena na false.Tento atribut nepoužívá Visual Studio IntelliSense informace.

• domElement
  Nepovinné.Tento atribut se již nepoužívá; type atribut přednost tomuto atributu.Tento atribut určuje, zda je vrácená hodnota dokumentované DOM element.Nastavit true určit, že vrácená hodnota je DOM element; jinak nastavena na false.Pokud type není nastaven atribut a domElement nastavena na true, IntelliSense dokumentované vrácená hodnota zachází jako HTMLElement při dokončování příkazů.

• mayBeNull
  Nepovinné.Určuje, zda dokumentované vrátit hodnotu lze nastavit na hodnotu null.Nastavit true k označení vrácenou hodnotu nastavit na hodnotu null; jinak nastavena na false.Výchozí hodnota je false.Tento atribut nepoužívá Visual Studio IntelliSense informace.

• elementType
  Nepovinné.Pokud type je Array, tento atribut určuje typ prvků v poli.

• elementInteger
  Nepovinné.Pokud type je Array a elementType je Number, tento atribut určuje, zda jsou prvky pole celých čísel.Nastavit true označíte, že jsou prvky pole celých čísel; jinak nastavena na false.Tento atribut nepoužívá Visual Studio IntelliSense informace.

• elementDomElement
  Nepovinné.Tento atribut se již nepoužívá; elementType atribut přednost tomuto atributu.Pokud type je Array, tento atribut určuje, zda DOM prvky jsou prvky pole.Nastavit true že prvky jsou prvky DOM; jinak nastavena na false.Pokud elementType není nastaven atribut a elementDomElement je nastavena na true, IntelliSense považuje každý prvek v poli jako HTMLElement při dokončování příkazů.

• elementMayBeNull
  Nepovinné.Pokud type je Array, určuje, zda prvky pole lze nastavit na hodnotu null.Nastavit true k označení prvků pole nastavit na hodnotu null; jinak nastavena na false.Výchozí hodnota je false.Tento atribut nepoužívá Visual Studio IntelliSense informace.

• locid
  Nepovinné.Identifikátor lokalizační informace o návratové hodnoty.Identifikátor je buď členské ID, nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Typ identifikátoru závisí na formátu zadaném v <loc> (JavaScript) značky.

• value
  Nepovinné.Určuje kód, který by měl být vyhodnocen pro použití podle IntelliSense místo samotného kódu funkce.Můžete například použít tento atribut poskytnout IntelliSense pro asynchronní zpětná volání, jako Promise.Použití value atributu s <returns> prvku můžete zvýšit výkon technologie IntelliSense vynechání dlouhé kódu.

• description
  Nepovinné.Popis vrácenou hodnotu.

Poznámky

<returns> Musí být prvek umístěn v těle funkce před všechny příkazy.

Příklad

Následující příklad kódu ukazuje, jak použít <returns> prvku.

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.

Viz také

Koncepty

Komentáře XML dokumentace (JavaScript)