Condividi tramite


<field> (JavaScript)

Specifica le informazioni della documentazione, inclusa una descrizione, per un campo o il membro che sono definiti in un oggetto.

<field name="fieldName" static="true|false" type="FieldType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID" value="code">description</field>

Parametri

  • name
    Il nome del campo o del membro.Quando l'elemento <field> viene utilizzato in una funzione costruttore, name è obbligatorio e definisce il membro a cui il tag viene applicato.Quando l'elemento <field> direttamente in annotando un campo, questo attributo viene ignorato e il nome utilizzato da Visual Studio è il nome del campo nel codice sorgente.

  • static
    Opzionale.Specifica se il campo è un membro della funzione costruttore o un membro dell'oggetto restituito dalla funzione costruttore.Impostare su true per gestire il campo come membro della funzione costruttore.Impostare su false per gestire il campo come membro dell'oggetto restituito dalla funzione costruttore.

  • type
    Opzionale.Il tipo di dati.Il tipo può essere:

    • Un linguaggio ECMAScript nella specifica di ECMAScript 5, come Number e Object.

    • Un oggetto DOM, come HTMLElement, Windowe Document.

    • Una funzione costruttore JavaScript.

  • integer
    Opzionale.Se type è Number, specifica se il campo è un Integer.Impostare su true per indicare che il campo è un valore; in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • domElement
    Opzionale.Questo attributo è stato deprecato; l'attributo type ha la precedenza su questo attributo.Questo attributo specifica se il campo è documentato un elemento DOM.Impostare su true per specificare che il campo è un elemento DOM; in caso contrario, insieme a false.Se l'attributo type non è impostato e domElement è impostato su true, IntelliSense considera il campo documentato come HTMLElement durante il completamento delle istruzioni.

  • mayBeNull
    Opzionale.Specifica se il campo documentato può essere impostato su null.Impostare su true per indicare che il campo può essere impostato su null; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • elementType
    Opzionale.Se type è Array, questo attributo specifica il tipo degli elementi nella matrice.

  • elementInteger
    Opzionale.Se type è Array e elementType è Number, questo attributo consente di specificare se gli elementi nella matrice di Integer.Impostare su true per indicare che gli elementi nella matrice di Integer, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • elementDomElement
    Opzionale.Questo attributo è stato deprecato; l'attributo elementType ha la precedenza su questo attributo.Se type è Array, questo attributo consente di specificare se gli elementi nella matrice sono elementi DOM.Impostare su true per specificare che gli elementi sono elementi DOM, in caso contrario, insieme a false.Se l'attributo elementType non è impostato e elementDomElement è impostato su true, IntelliSense considera ogni elemento della matrice come HTMLElement durante il completamento delle istruzioni.

  • elementMayBeNull
    Opzionale.Se type è Array, specifica se gli elementi nella matrice possono essere impostati su null.Impostare su true per indicare che gli elementi nella matrice possono essere impostati su null; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • helpKeyword
    Opzionale.La parola chiave della Guida.

  • locid
    Opzionale.L'identificatore per informazioni sulla localizzazione sul campo.L'identificatore è un membro o ID o corrisponde al valore di attributo name in un gruppo di messaggio definito dai metadati di OpenAjax.Il tipo dell'identificatore dipende dal formato specificato nel tag <loc> (JavaScript).

  • value
    Opzionale.Specifica il codice che deve essere valutato da IntelliSense anziché il codice della funzione.Per <field>, questo attributo è supportato per le funzioni costruttore, ma non è supportato per i valori letterali di oggetto.È possibile utilizzare questo attributo è necessario fornire le informazioni sul tipo al tipo di campo viene definito.Ad esempio, è possibile utilizzare value=’1’ per gestire il tipo di campo come numero.

  • description
    Opzionale.Una descrizione per il campo.

Note

L'attributo name è obbligatorio quando si relativo a un campo in una funzione costruttore.Per tutti gli altri scenari, tutti gli attributi per l'elemento <field> sono facoltativi.

Quando si relativo a una funzione costruttore, l'elemento <field> deve trovarsi subito prima della dichiarazione di campo.L'attributo name deve corrispondere al nome campo utilizzato nel codice sorgente.Per i membri dell'oggetto, l'attributo name può essere omesso se l'elemento <field> viene visualizzato immediatamente prima della dichiarazione del membro dell'oggetto.

Esempio

Le esempio di codice seguente viene illustrato come utilizzare l'elemento <field>.

// Use of <field> in an object definition.
var Rectangle = {
    /// <field type = 'Number'>The width of the rectangle.</field>
    wid: 5,
    /// <field type = 'Number'>The length of the rectangle.</field>
    len: 0,
    /// <field type='Number'>Returns the area of the rectangle.</field>
    getArea: function (wid, len) {
        return len * wid;
    }
}

// Use of <field> in a constructor function.
// The name attribute is required.
function Engine() {
    /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
    this.HorsePower = 150;
}

Di seguito viene illustrato come utilizzare l'elemento <field> con l'attributo static a true.

function Engine() {
    /// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}

Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.  

Di seguito viene illustrato come utilizzare l'elemento <field> con l'attributo static a false.

function Engine() {
    /// <field name='HorsePower' static='false' type='Number'>Non-static field desc.</field>
}

Engine.HorsePower = 140;
var eng = new Engine();
// IntelliSense on the field is available here.
eng.  

Di seguito viene illustrato come utilizzare l'elemento <field> con l'attributo value.

function calculator(a) {
    /// <field name='f' value='1'/>
}
new calculator().f.   // Completion list for a Number.

Vedere anche

Concetti

Commenti relativi alla documentazione XML (JavaScript)