共用方式為


<param> (JavaScript)

為參數指定的物件在函式或方法。

<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>

參數

  • name
    必要項。 參數的名稱。

  • type
    選擇項。 參數的資料型別。 型別可以是下列其中一項:

    • ECMAScript 語言類型 ECMAScript 的規格,例如 NumberObject

    • DOM 物件,例如 HTMLElementWindowDocument

    • JavaScript 建構函式。

  • integer
    選擇項。 如果 type 是 Number,指定參數是否為整數。 設定為 true 表示參數是整數;否則,設定為 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • domElement
    選擇項。 這個屬性已被取代; type 屬性優先於這個屬性。 這個屬性指定文件的參數是 DOM 項目。 設定為 true 指定參數是 DOM 項目;否則,設定為 false。 如果 type 屬性未設定,而且 domElement 設為 true, IntelliSense 會將文件的參數做為 HTMLElement ,當執行陳述式完成時。

  • mayBeNull
    選擇項。 指定文件的參數是否可以設定為 null。 設定為 true 表示該參數可設為 null;否則,設定為 false。 預設值是 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • elementType
    選擇項。 如果 type 是 Array,這個屬性在陣列指定之項目的型別。

  • elementInteger
    選擇項。 如果 type 是 Array ,並 elementType 是 Number,這個屬性指定陣列中的項目是否為整數。 設定為 true 表示陣列中的項目是整數;否則,設定為 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • elementDomElement
    選擇項。 這個屬性已被取代; elementType 屬性優先於這個屬性。 如果 type 是 Array,這個屬性指定陣列中的項目是否為 DOM 項目。 設定為 true 指定項目是 DOM 項目;否則,設定為 false。 如果 elementType 屬性未設定,而且 elementDomElement 設為 true, IntelliSense 會將陣列中的每個項目做為 HTMLElement ,當執行陳述式完成時。

  • elementMayBeNull
    選擇項。 如果 type 是 Array,指定陣列中的項目是否可以設定為 null。 設定為 true 表示陣列中的項目可以設定為 null;否則,設定為 false。 預設值是 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • locid
    選擇項。 識別項對參數的當地語系化資訊。 識別項是或成員 ID 或其對應於 OpenAjax 中繼資料在訊息繫結的 name 屬性值所定義。 識別項的型別取決於 <loc> (JavaScript) 項目指定的格式。

  • parameterArray
    選擇項。 是否在函式呼叫指定文件的參數可以重複,類似於迴圈中 String.format 函式支援的參數。 設定為 true 表示參數可以重複;否則,設定為 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • optional
    選擇項。 指定文件的參數是否為選擇性項目在呼叫的函式。 設定為 true 表示參數是選擇性的;否則,設定為 false。

  • value
    選擇項。 指定應該評估供 IntelliSense 而不是函式程式碼的程式碼。 做為參數型別未定義時,您可以使用這個屬性要提供型別資訊。 例如,您可以使用 value=’1’ 視為參數型別為數字。

  • description
    選擇項。 參數的描述。

備註

唯一的必要屬性是 name。 其他屬性是選擇性的。

在任何陳述式之前的函式主體必須將用於項目加註函式,例如 <summary> (JavaScript)<param> (JavaScript)<returns> (JavaScript),。

如果有相同名稱的多個 <param> 項目,請使用其中一個 <param> 項目,並重複項目被忽略。 判斷的行為使用哪個項目未定義。 如果 name 參考到不存在的參數,則會忽略項目。

範例

下列程式碼範例示範如何使用 <param> 項目。

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

// Uses of <param> with the value attribute.

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

function calculate(a) {
    /// <param name='a' value='{x:0,y:0}'/>
    a.    // x and y appear in the completion list.
}

請參閱

概念

XML 文件註解 (JavaScript)