建議使用 Visual Studio 2017

<signature> (JavaScript)

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件

一組函式或方法的相關項目可以為多載函式的文件。

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

參數

externalid
選擇項。 如果 <loc> 項目的 format 屬性是 vsdoc,則這個屬性會指定用於成員 ID 找出與簽章的 XML 程式碼。 不同於 locid 屬性,此屬性指定的成員應該載入所有項目在具有此 ID。 所有相關聯的說明資訊目前在 XML 程式碼以在簽章中指定的項目也會結合。 這在右邊的檔案讓您可以不需要在原始碼中指定就能指定其他額外的元素,像是<capability>externalid這是一個選擇性的屬性。

externalFile
選擇項。 指定用來尋找 externalid的檔案名稱。 如果externalid 不存在,則屬性會被忽略。 這是一個選擇性的屬性。 預設值是目前檔案的名稱,但副檔名為.xml 而非 .js。 根據預設, Managed 資源當地語系化的查詢規則來尋找檔案。

helpKeyword
選擇項。 F1 Help 的關鍵字。

locid
選擇項。 識別項對欄位的當地語系化資訊。 識別項是成員 ID 或其對應於 OpenAjax 中繼資料在訊息繫結所定義的 name 屬性值。 識別項的型別取決於在 <loc> 標記中指定的格式。

使用每個多載函式描述的 <signature> 項目在 .js 檔案或指定的每個外部成員 ID 使用一個 <signature> 項目。

<signature> 項目必須置於任何陳述式之前的函式主體。 使用 <summary>時, <param><returns> 項目與 <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 文件註解

顯示: