<signature> (JavaScript)

Článek
03/04/2013

Seskupení souvisejících prvků pro funkci nebo metodu poskytnout dokumentaci přetížené funkce sada.

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

Parametry

externalid
Nepovinné.Pokud format pro atribut <loc> (JavaScript) prvkem je vsdoc, tento atribut určuje ID slouží k vyhledání kód XML, který je spojený s podpisem člena.Na rozdíl od locid atribut, tento atribut určuje, že všechny prvky člen, který má toto ID má být načten.Popis související informace v kódu XML bude také sloučena s prvky uvedené v podpisu.To umožňuje určit další prvky, jako například <capability>, v souboru přívěsného vozíku bez určení jejich ve zdrojovém souboru.externalidje volitelný atribut.
externalFile
Nepovinné.Určuje název souboru, ve kterém naleznete externalid.Tento atribut je ignorována, pokud ne externalid je k dispozici.Toto je volitelný atribut.Výchozí hodnota je název aktuálního souboru, ale s příponou XML namísto js.Ve výchozím nastavení spravovaného prostředku vyhledávání pravidla pro lokalizaci slouží k vyhledání souboru.
helpKeyword
Nepovinné.Klíčové slovo nápovědy F1
locid
Nepovinné.Identifikátor lokalizační informace o poli.Identifikátor je buď členské ID, nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Typ identifikátoru závisí na formátu zadaném v <loc> (JavaScript) značky.

Poznámky

Použijte jednu <signature> pro každý prvek přetížené funkce Popis JS nebo použijte jednu <signature> element pro každé zadané ID člena externí.

<signature> Musí být prvek umístěn v těle funkce před všechny příkazy.Při použití <summary> (JavaScript), <param> (JavaScript), nebo <returns> (JavaScript) s prvky <signature> prvek, umístit další prvky uvnitř <signature> bloku.

Příklad

Následující příklad kódu ukazuje, jak použít <signature> prvku.

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

Viz také

Koncepty

Komentáře XML dokumentace (JavaScript)

Sdílet prostřednictvím