<returns> (JavaScript)

Określa informacje dokumentacji w wyniku wywołania funkcji lub 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
  Opcjonalne.Typ danych zwracanej wartości.Typ może być jedną z następujących czynności:

  • Języka ECMAScript wpisz w specyfikacji ECMAScript 5, takich jak Number i Object.

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

  • Funkcja konstruktora JavaScript.

• integer
  Opcjonalne.Jeśli type jest Number, określa, czy zwracana wartość jest liczbą całkowitą.Ustaw true , aby wskazać, że zwracana wartość jest liczbą całkowitą; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.

• domElement
  Opcjonalne.Ten atrybut jest niezalecane; type atrybutu ma pierwszeństwo przed tego atrybutu.Ten atrybut określa, czy udokumentowane zwracana jest wartość elementu DOM.Ustaw true , aby określić, że zwracana jest wartość elementu DOM; w przeciwnym razie jest ustawiona na false.Jeśli type atrybut nie jest ustawiony i domElement jest ustawiona true, IntelliSense traktuje udokumentowane wartości zwracanej jako HTMLElement podczas wykonywania instrukcji.

• mayBeNull
  Opcjonalne.Określa, czy udokumentowane zwrotu można ustawić wartość NULL.Ustaw true , aby wskazać można ustawić wartość zwracana wartość NULL; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.

• elementType
  Opcjonalne.Jeśli type jest Array, ten atrybut określa typ elementów w tablicy.

• elementInteger
  Opcjonalne.Jeśli type jest Array i elementType jest Number, ten atrybut określa, czy elementy w tablicy są liczby całkowite.Ustaw true , aby wskazać, że elementów w tablicy liczb całkowitych; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.

• elementDomElement
  Opcjonalne.Ten atrybut jest niezalecane; elementType atrybutu ma pierwszeństwo przed tego atrybutu.Jeśli type jest Array, ten atrybut określa, czy elementy w tablicy są elementami DOM.Ustaw true elementy są elementami DOM; w przeciwnym razie jest ustawiona na false.Jeśli elementType atrybut nie jest ustawiony i elementDomElement jest ustawiona true, IntelliSense traktuje każdy element w tablicy jako HTMLElement podczas wykonywania instrukcji.

• elementMayBeNull
  Opcjonalne.Jeśli type jest Array, określa, czy elementy w tablicy można ustawić na wartość null.Ustaw true do wskazania elementów w tablicy można ustawić wartość NULL; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.

• locid
  Opcjonalne.Identyfikator lokalizacji informacji na temat wartości zwracanej.Identyfikator jest albo członkiem lub identyfikator odpowiada name wartość w wiązce wiadomości definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu określonego w <loc> (JavaScript) tag.

• value
  Opcjonalne.Określa kod, który powinno zostać ocenione do użytku przez technologię IntelliSense zamiast kodu funkcji.Na przykład za pomocą tego atrybutu przewidzieć IntelliSense asynchronicznych wywołań zwrotnych, takich jak Promise.Za pomocą value atrybutu z <returns> element może zwiększyć wydajność technologii IntelliSense pomijając wykonanie kodu długie.

• description
  Opcjonalne.Opis wartości zwracanej.

Uwagi

<returns> Elementu muszą być umieszczone w treści funkcji przed wszelkie oświadczenia.

Przykład

Poniższy przykład kodu pokazuje, jak używać <returns> element.

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.

Zobacz też

Koncepcje

Komentarzy dokumentacji XML (JavaScript)