<signature> (JavaScript)

一组函数或方法,以便提供对于重载函数的文档关联的元素。

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

参数

  • externalid
    可选。 如果format属性的<loc> (JavaScript)元素是vsdoc,此属性指定的成员 ID,用于定位与签名关联的 XML 代码。 与locid属性,此属性指定是否应加载具有此 ID 的成员中的所有元素。 签名中指定的元素也将合并 XML 代码中存在任何关联的说明信息。 这使您可以指定其他元素,如<capability>,而无需在源文件中指定的附属文件中。 externalid是一个可选属性。

  • externalFile
    可选。 指定要查找的文件的名称externalid。 如果没有,则将忽略此属性externalid是否存在。 这是一个可选属性。 默认值是当前文件但扩展名为.xml 的.js 而不是具有名称。 默认情况下进行本地化的托管的资源查找规则用于查找文件。

  • helpKeyword
    可选。 F1 帮助关键字。

  • locid
    可选。 有关本地化字段标识符。 该标识符是任何一个成员 ID 或它对应于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)