<signature> (JavaScript)
Agrupa um conjunto de elementos inter-relacionados para uma função ou um método fornece a documentação para funções sobrecarregadas.
<signature externalid="id" externalFile="filename"
helpKeyword="keyword" locid="descriptionID">
</signature>
Parâmetros
externalid
Opcional.Se o atributo de format para o elemento de <loc> (JavaScript) é vsdoc, esse atributo especifica a identificação do membro usado para localizar o código XML que está associado com a assinatura.Diferentemente de atributo de locid , esse atributo especifica que todos os elementos no membro que tem esta identificação devem ser carregados.Todas as informações associadas de descrição atual no código XML também será mesclada com elementos especificados na assinatura.Isso permite que você especifique os elementos adicionais, como <capability>, no arquivo de side-car sem especifique o arquivo de origem.externalid é um atributo opcional.externalFile
Opcional.Especifica o nome do arquivo para localizar externalid.Esse atributo é ignorado se nenhum externalid presente.Este é um atributo opcional.O valor padrão é o nome do arquivo atual mas com uma extensão de arquivo .xml em vez de .js.Por padrão, as regras gerenciados de pesquisa de recursos para localização são usadas para localizar o arquivo.helpKeyword
Opcional.A palavra-chave para F1 ajuda.locid
Opcional.O identificador para informações de localização no campo.O identificador é ou um ID do membro ou corresponde ao valor do atributo de name em um pacote de mensagem definida por metadados de OpenAjax.O tipo identificador depende de formato especificado na marca de <loc> (JavaScript) .
Comentários
Use um elemento de <signature> para cada sobrecarregada descrição da função no arquivo .js, ou use um elemento de <signature> para cada identificação externo do membro especificado.
O elemento de <signature> deve ser colocado no corpo da função antes de quaisquer declarações.Ao usar <summary> (JavaScript), <param> (JavaScript), ou elementos de <returns> (JavaScript) com o elemento de <signature> , coloque os outros elementos dentro do bloco de <signature> .
Exemplo
O exemplo de código a seguir mostra como usar o elemento de <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;
}