<field> (JavaScript)
Gibt Dokumentationsinformationen, einschließlich einer Beschreibung, entweder für ein Feld oder Member an, die auf einem Objekt definiert ist.
<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>
Parameter
name
Der Name des Felds oder Members.Wenn das <field>-Element in einer Konstruktorfunktion verwendet wird, ist name erforderlich und definiert den Member, auf den das Tag gilt.Wenn das <field>-Element direkt ein Feld Kommentare, wird dieses Attribut ignoriert, und der Name, der von Visual Studio verwendet wird, ist der Name des tatsächlichen Felds im Quellcode.static
Dies ist optional.Gibt an, ob das Feld Mitglied der Konstruktorfunktion oder ein Member des Objekts ist, das durch die Konstruktorfunktion zurückgegeben wird.Legen Sie auf true, um des Felds als Member der Konstruktorfunktion zu behandeln.Legen Sie auf false, um des Felds als Member des Objekts zu behandeln zurückgegeben durch die Konstruktorfunktion.type
Dies ist optional.Der Datentyp des Felds.Der Typ sind zulässig:Eine ECMAScript-Sprache geben die Spezifikation ECMAScript 5, wie Number und Object ein.
Ein DOM-Objekt, wie HTMLElement, Window und Document.
Eine JavaScript-Konstruktorfunktion.
integer
Dies ist optional.Wenn typeNumber ist, gibt an, ob das Feld eine ganze Zahl ist.Legen Sie auf true, anzugeben, dass das Feld eine ganze Zahl ist, Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.domElement
Dies ist optional.Dieses Attribut ist veraltet; type das Attribut hat Vorrang vor diesem Attribut.Dieses Attribut gibt an, ob das Belegfeld ein DOM-Element ist.Legen Sie auf true, anzugeben, dass das Feld ein DOM-Element ist; Wird andernfalls zu false.Wenn das Attribut nicht type festgelegt ist und domElement zu true festgelegt wird, behandelt das IntelliSense Belegfeld als HTMLElement, wenn Anweisungsvervollständigung ausführt.mayBeNull
Dies ist optional.Gibt an, ob das Belegfeld festgelegt werden kann, um ungültig zu machen.Legen Sie auf true, anzugeben, dass das Feld festgelegt werden kann, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementType
Dies ist optional.Wenn typeArray ist, gibt dieses Attribut den Typ der Elemente im Array an.elementInteger
Dies ist optional.Wenn typeArray ist und elementTypeNumber ist, gibt dieses Attribut an, ob die Elemente im Array ganze Zahlen sind.Legen Sie auf true, anzugeben, dass die Elemente im Array ganze Zahlen sind; Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementDomElement
Dies ist optional.Dieses Attribut ist veraltet; elementType das Attribut hat Vorrang vor diesem Attribut.Wenn typeArray ist, gibt dieses Attribut an, ob die Elemente im Array DOM-Elemente sind.Legen Sie auf true, anzugeben, dass die Elemente DOM-Elemente sind; Wird andernfalls zu false.Wenn das Attribut nicht elementType festgelegt ist und elementDomElement zu true festgelegt wird, behandelt IntelliSense jedes Element im Array als HTMLElement, wenn Anweisungsvervollständigung ausführt.elementMayBeNull
Dies ist optional.Wenn typeArray ist, gibt an, ob die Elemente im Array festgelegt werden können, um ungültig zu machen.Legen Sie auf true, anzugeben, dass die Elemente im Array festgelegt werden können, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.helpKeyword
Dies ist optional.Das Schlüsselwort für F1-Hilfe.locid
Dies ist optional.Der Bezeichner für Lokalisierungsinformation zum Feld.Der Bezeichner ist entweder eine Member ID, oder sie entspricht dem name-Attributwert in einem Meldungsbündel, das von OpenAjax-Metadaten definiert ist.Der Bezeichnertyp hängt vom Format ab, das im <loc> (JavaScript)-Tag angegeben wird.value
Dies ist optional.Gibt Code an, der für IntelliSense anstelle des Funktionscodes ausgewertet werden sollte selbst.Für <field> wird dieses Attribut für Konstruktorfunktionen unterstützt, jedoch nicht für Objektliterale unterstützt.Sie können dieses Attribut verwenden sollen Typinformationen bereitstellen, wenn der Feldtyp nicht definiert ist.Beispielsweise können Sie value=’1’ verwenden, um den Feldtyp als Zahl zu behandeln.description
Dies ist optional.Eine Beschreibung für das Feld.
Hinweise
Das name-Attribut ist erforderlich, wenn Sie ein Feld in einer Konstruktorfunktion dokumentieren.Für alle anderen Szenarien sind alle Attribute für das Element <field> optional.
Wenn Sie eine Konstruktorfunktion dokumentieren, muss das <field>-Element direkt vor der Bitfelddeklaration angezeigt werden.Das name-Attribut muss den Feldnamen übereinstimmen, der im Quellcode verwendet wird.Für Objektmember kann das name-Attribute ausgelassen werden, wenn das <field>-Element direkt vor der Objektmemberdeklaration angezeigt wird.
Beispiel
Das folgende Codebeispiel zeigt, wie das <field>-Element verwendet.
// 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;
}
Das folgende Beispiel zeigt, wie das <field>-Element mit dem - Attribut festgelegte static zu true verwendet.
function Engine() {
/// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}
Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.
Das folgende Beispiel zeigt, wie das <field>-Element mit dem - Attribut festgelegte static zu false verwendet.
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.
Das folgende Beispiel zeigt, wie das <field>-Element mit dem Attribut value verwendet.
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.