<signature> (JavaScript)
Группирует набор связанных элементов для функции или метода для предоставления документации для перегруженных функций.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Параметры
externalid
Необязательный параметр.Если format атрибут для <loc> (JavaScript) элемент vsdoc, этот атрибут определяет идентификатор, используемый для обнаружения XML-код, связанный с подписью члена.В отличие от locid атрибута этот атрибут задает загрузки всех элементов в элемент, имеющий этот идентификатор.Также будут объединены все связанные описания данные из XML-кода с элементами, указанному в подписи.Это позволяет указать дополнительные элементы, такие как <capability>, в сопроводительным файлом без указания их в исходном файле.externalidЭто необязательный атрибут.externalFile
Необязательный параметр.Указывает имя файла, в котором поиск externalid.Этот атрибут обрабатывается, если не externalid присутствует.Это необязательный атрибут.Значение по умолчанию — имя текущего файла, но с расширением .xml вместо .js.По умолчанию правила подстановки управляемого ресурса для локализации используются для поиска файла.helpKeyword
Необязательный параметр.Ключевое слово справки F1.locid
Необязательный параметр.Идентификатор для локализации информации о поле.Идентификатор является участником ID, или он относится к name значение в пакете сообщения, определенные метаданные альянсе атрибута.Тип идентификатора зависит от формата, указанного в <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;
}