<signature> (JavaScript)

一组函数或方法的相关元素可以为重载函数提供文档。

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

参数

  • externalid
    可选。如果format 特性关于<loc> (JavaScript) element is vsdoc, 此属性指定用于定位的带有签名相关的XML代码的成员编号。不同于locid 特性,此属性指定应该加载在具有该ID的成员的所有元素。所有关联的参考信息的 XML 代码与在签名中指定的元素也会合并。这会使你指定额外的元素,例如<capability>, 在源文件中没有指定它们的附属文件。externalid此特性是可选的。

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

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

  • locid
    可选。有关字段本地化信息的标识符。该标识符是成员编号或它对应于OpenAjax元数据定义在消息绑定的 name 属性值。这个标示符依赖在 <loc> (JavaScript) 标签中的指定形式。

备注

为.js文件中每个超载函数描述使用<signature>元素,或为每个外部成员编号使用<signature>元素。

在任何声明之前,<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)