共用方式為


<signature> (JavaScript)

群組中一組函式或方法,以提供多載函式的說明文件相關的項目。

<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature> 

參數

  • externalid
    選擇項。 如果format屬性的<loc> (JavaScript)項目是vsdoc,這個屬性會指定識別碼可用來找出已簽章相關聯的 XML 程式碼的成員。 不像locid屬性,這個屬性會指定成員具有此 ID 中的所有項目應被載入。 XML 程式碼中出現任何相關聯的描述資訊也會合併與簽章中指定的項目。 這可讓您指定額外的項目,例如<capability>,而不需要指定這些原始程式檔中的 sidecar 檔案中。 externalid是一個選擇性屬性。

  • externalFile
    選擇項。 指定在其中找到的檔案名稱externalid。 如果沒有,則會忽略這個屬性externalid已存在。 這是選擇性的屬性。 預設值是檔案的目前,但.js 代替.xml 副檔名的名稱。 根據預設值,以配合當地語系化的受管理的資源查閱規則用來找出檔案。

  • helpKeyword
    選擇項。 F1 說明關鍵字。

  • locid
    選擇項。 如需有關此欄位的當地語系化資訊識別項。 識別項是成員,不論是哪一識別碼,或相對於name屬性在訊息集結 OpenAjax 中繼資料所定義的值。 識別項型別中指定的格式而定<loc> (JavaScript)標記。

備註

使用其中一種<signature>項目,每個多載函式描述在.js 檔案中或使用其中一種<signature>指定每個外部的會員 ID 的項目。

<signature>項目必須放在函式主體之前的任何陳述式。 當使用<summary> (JavaScript)<param> (JavaScript),或<returns> (JavaScript)項目具有<signature>項目,將其他項目放<signature>區塊。

範例

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

    // Use of <signature> with externalid.
    // Requires use of the <loc> tag to identify the external functions.
    function illuminate(light) {
        /// <signature externalid='M:Windows.Devices.Light.Illuminate()' />
        /// <signature externalid='M:Windows.Devices.Light.Illuminate(System.Int32)'>
        ///   <param name='light' type='Number' />
        /// </signature>
    }

    // Use of <signature> for overloads implemented in JavaScript.
    function add(a, b) {
        /// <signature>
        /// <summary>function summary 1</summary>
        /// <param name="a" type="Number">The first number</param>
        /// <param name="b" type="Number">The second number</param>
        /// <returns type="Number" />
        /// </signature>
        /// <signature>
        /// <summary>function summary 2 – differ by number of params</summary>
        /// <param name="a" type="Number">Only 1 parameter</param>
        /// <returns type="Number" />
        /// </signature>
        /// <signature>
        /// <summary>function summary 3 – differ by parameter type</summary>
        /// <param name="a" type="Number">Number parameter</param>
        /// <param name="b" type="String">String parameter</param>
        /// <returns type="Number" />
        /// </signature>
        /// <signature>
        /// <summary>function summary 4 – differ by return type</summary>
        /// <param name="a" type="Number">The first number</param>
        /// <param name="b" type="Number">The second number</param>
        /// <returns type="String" />
        /// </signature>

        return a + b;
    }

請參閱

概念

XML 文件註解 (JavaScript)