<returns> (JavaScript)

Makale
02/26/2013

Bir işlev veya yöntem çağrısı sonuç belgelerine bilgilerini belirtir.

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

Parametreler

type
İsteğe Bağlı. Sonuç değerin veri türü. Tür, aşağıdakilerden biri olabilir:
- ECMAScript dil yazın 5 ECMAScript belirtimi, aþaðýdaki gibi Number ve Object.
- A DOM object, such as HTMLElement, Window, and Document.
- JavaScript yapıcı işlevi.
integer
İsteğe Bağlı. type Olan Number, dönüş değeri bir tamsayı olup olmadığını belirtir. Ayarlamak true dönüş değeri bir tamsayı; olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.
domElement
İsteğe Bağlı. Bu özniteliği önerilmiyor; type özniteliği üzerinde bu özniteliğe göre önceliklidir. Bu öznitelik belgelenen dönüş değeri bir dom öğesi olup olmadığını belirtir. Ayarlamak true dönüş değeri bir dom öğesi; olduğunu belirtmek için Aksi takdirde set false. type Özniteliğinin ayarlanmadığından ve domElement ayarlamak true, IntelliSense belgelenen dönüş değeri nitelendirir bir HTMLElement deyimi tamamlama işlemi yaparken.
mayBeNull
İsteğe Bağlı. Belgelenen değeri ayarlanabilir döndürüp döndürmeyeceğini belirtir null. Ayarlamak true dönüş değeri kümesi belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.
elementType
İsteğe Bağlı. type Olan Array, bu öznitelik Dizideki öğelerin türünü belirtir.
elementInteger
İsteğe Bağlı. type Olan Array ve elementType olan Number, bu öznitelik, dizideki öğelerin tamsayılar olup olmadığını belirtir. Ayarlamak true Dizideki öğelerin tamsayı; olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.
elementDomElement
İsteğe Bağlı. Bu özniteliği önerilmiyor; elementType özniteliği üzerinde bu özniteliğe göre önceliklidir. type Olan Array, bu öznitelik, dizideki öğelerin dom öğeler olup olmadığını belirtir. Ayarlamak true öğeleri dom öğeleri; olduğunu belirtmek için Aksi takdirde set false. elementType Özniteliğinin ayarlanmadığından ve elementDomElement ayarlamak true, IntelliSense her bir öğesi olarak değerlendirir bir HTMLElement deyimi tamamlama işlemi yaparken.
elementMayBeNull
İsteğe Bağlı. type Olan Array, dizideki öğelerin ayarlanıp ayarlanamadığını belirtir null. Ayarlamak true dizideki öğeler kümesi belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.
locid
İsteğe Bağlı. Dönüş değeri hakkındaki bilgileri yerelleştirme için tanımlayıcı. Bir üye tanımlayıcısıdır kimliği veya karşılık gelen name özniteliği değerini OpenAjax meta veriler tarafından tanımlanan ileti paketteki. Belirtilen biçim tanımlayıcısı türü bağlıdır <loc> (JavaScript) etiket.
value
İsteğe Bağlı. İşlev kodu kendisini IntelliSense tarafından kullanılmak üzere değerlendirilmelidir kodunu belirtir. Örneğin, zaman uyumsuz geri aramalar için IntelliSense gibi sağlamak için bu özniteliği kullanabilirsiniz bir Promise. Kullanarak value ile öznitelik <returns> öğesi, uzun kod yürütülmesine atlayarak IntelliSense performansı geliştirebilir.
description
İsteğe Bağlı. Dönüş değeri bir açıklaması.

Notlar

<returns> Öğesi, işlev gövdesinde bildirisinden önce yerleştirilmelidir.

Örnek

Aşağıdaki kod örneği nasıl kullanılacağını gösteren <returns> öğesi.

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.

Ayrıca bkz.

Kavramlar

xml belgesi açıklamalarının (JavaScript)

Aracılığıyla paylaş