<field> (JavaScript)

Článek
03/04/2013

Určuje informace o dokumentaci, včetně popisu, pole nebo člen, který je definován na objekt.

<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>

Parametry

name
Název pole nebo člena.Když <field> použit element v konstruktoru funkce name je vyžadován a definuje člen, na které se vztahuje na značku.Když <field> prvek je přímo poznámky, pole, je tento atribut ignorován a název skutečné pole ve zdrojovém kódu je název používaný v aplikaci Visual Studio.
static
Nepovinné.Určuje, zda pole je členem funkce konstruktoru nebo členem objekt vrácený funkcí konstruktoru.Nastavte true pole považovat členské funkce konstruktoru.Nastavte false pole považovat členské funkce konstruktoru objektu.
type
Nepovinné.Typ dat pole.Typ může být jeden z následujících:
- Zadejte jazyka ECMAScript specifikace ECMAScript 5 jako Number a Object.
- A DOM object, such as HTMLElement, Window, and Document.
- Funkce konstruktoru jazyka JavaScript.
integer
Nepovinné.Pokud type je Number, určuje, zda je pole celé číslo.Nastavte true označuje, že pole je celé číslo; v opačném případě nastavte false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.
domElement
Nepovinné.Tento atribut je zastaralý; type atribut přednost tento atribut.Tento atribut určuje, zda je pole dokumentované element modelu DOM.Nastavte true určit, že pole je element modelu DOM; v opačném případě nastavte false.Pokud type atribut není nastaven a domElement je nastavena na true, IntelliSense zpracovává dokumentované pole HTMLElement při dokončování.
mayBeNull
Nepovinné.Určuje, zda zdokumentované pole lze nastavit na hodnotu null.Nastavte true označuje, že pole můžete nastavit na hodnotu null; v opačném případě nastavte false.Výchozí hodnota je false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.
elementType
Nepovinné.Pokud type je Array, tento atribut určuje typ prvků v poli.
elementInteger
Nepovinné.Pokud type je Array a elementType je Number, tento atribut určuje, zda jsou prvky pole celých čísel.Nastavte true označuje, že jsou prvky pole celých čísel; v opačném případě nastavte false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.
elementDomElement
Nepovinné.Tento atribut je zastaralý; elementType atribut přednost tento atribut.Pokud type je Array, tento atribut určuje, zda jsou prvky pole, elementy modelu DOM.Nastavte true že prvky jsou prvky modelu DOM; v opačném případě nastavte false.Pokud elementType není nastaven atribut a elementDomElement je nastavena na true, technologie IntelliSense zpracovává každý prvek v poli jako HTMLElement při dokončování.
elementMayBeNull
Nepovinné.Pokud type je Array, určuje, zda lze prvky pole nastavit na hodnotu null.Nastavte true označující, že prvky pole, můžete nastavit na hodnotu null; v opačném případě nastavte false.Výchozí hodnota je false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.
helpKeyword
Nepovinné.Klíčové slovo nápovědy F1
locid
Nepovinné.Identifikátor pro lokalizaci informace o poli.Buď člen je identifikátor ID nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Identifikátor typu závisí na formátu zadaném v <loc> (JavaScript) značky.
value
Nepovinné.Určuje kód, který by měl být vyhodnocen použít technologii IntelliSense místo samotného kódu funkce.Pro <field>, tento atribut je podporován pro konstruktoru funkce však není podporována pro objekt literály.Můžete použít tento atribut je poskytnout informace o typu je definován typ pole.Například můžete použít value=’1’ považovat pole typu číslo.
description
Nepovinné.Popis pole.

Poznámky

name Atribut je vyžadován, pokud nejste dokumentování pole ve funkci konstruktoru.Další scénáře všechny atributy pro <field> element jsou volitelné.

Když jste dokumentování funkce konstruktoru, <field> element musí být bezprostředně před deklarací pole.name Atribut musí odpovídat názvu pole použité ve zdrojovém kódu.Pro členy objektu name atribut lze vynechat, pokud <field> element se zobrazí bezprostředně před členské deklarace objektu.

Příklad

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

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

Následující příklad zobrazuje způsob použití <field> element s static atribut nastaven na 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.

Následující příklad zobrazuje způsob použití <field> element s static atribut nastaven na 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.

Následující příklad zobrazuje způsob použití <field> element s value atribut.

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

Viz také

Koncepty

Komentáře XML dokumentace (JavaScript)

Sdílet prostřednictvím