<field> (JavaScript)
オブジェクトで定義されたメンバーまたはフィールドのドキュメント情報について説明しますが、指定します。
<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>
パラメーター
name
フィールドまたはメンバーの名前。<field> の要素がコンストラクター関数で使用すると、name は必須で、タグを適用するメンバーを定義します。<field> の要素が直接フィールドを指定する場合、この属性は無視され、Visual Studioで使用される名前はソース・コード内の実際のフィールドの名前です。static
省略可能。フィールドがコンストラクター関数のメンバーまたはコンストラクター関数によって返されるオブジェクトのメンバーかどうかを指定します。コンストラクター関数のメンバーとしてフィールドを処理 true に設定します。オブジェクトのメンバーがコンストラクター関数によって返されるようにフィールドを処理 false に設定します。type
省略可能。フィールドのデータ型。型は、次のいずれかの値:ECMAScriptの Number と ObjectなどのECMAScript 5の仕様を、言語。
HTMLElement、Windowと DocumentなどのDOMオブジェクト。
JavaScriptのコンストラクター関数。
integer
省略可能。type が Number場合、フィールドは整数であるかどうかを指定します。フィールドが整数であることを示すために true に設定します; それ以外 falseに設定します。Visual Studioには、この属性がIntelliSense情報を提供するためには使用されません。domElement
省略可能。この属性は避けてください; type の属性がこの属性より優先されます。この属性は文書化したフィールドがDOM要素であるかどうかを指定します。フィールドがDOM要素であることを指定するに true に設定します; それ以外 falseに設定します。type の属性が設定されていない場合、domElementtrueがに設定されている場合、IntelliSenseは HTMLElement として、ステートメント入力候補を実行するときにドキュメント化のフィールドを処理します。mayBeNull
省略可能。文書化したフィールドがnullに設定できるかどうかを指定します。フィールドがnullに設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studioには、この属性がIntelliSense情報を提供するためには使用されません。elementType
省略可能。type が Arrayの場合、この属性は配列の要素の型を指定します。elementInteger
省略可能。type が Array 場合、elementType が Numberの場合、この属性は配列の要素が整数であるかどうかを指定します。配列の要素が整数であることを示すために true に設定します; それ以外 falseに設定します。Visual Studioには、この属性がIntelliSense情報を提供するためには使用されません。elementDomElement
省略可能。この属性は避けてください; elementType の属性がこの属性より優先されます。type が Arrayの場合、この属性は配列の要素がDOM要素であるかどうかを指定します。要素がDOM要素であることを指定するに true に設定します; それ以外 falseに設定します。elementType の属性が設定されていない場合、elementDomElementtrueがに設定されている場合、IntelliSenseは HTMLElement として、ステートメント入力候補を実行するときに配列の各要素を処理します。elementMayBeNull
省略可能。type が Array場合、配列の要素がnullに設定できるかどうかを指定します。配列の要素がnullに設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studioには、この属性がIntelliSense情報を提供するためには使用されません。helpKeyword
省略可能。F1ヘルプのキーワード。locid
省略可能。フィールドについてのローカリゼーション情報の識別子。この識別子は、メンバーのIDであるか、またはOpenAjaxのメタデータで定義されているメッセージのバンドルの name の属性値に対応します。識別子の型は <loc> (JavaScript) のタグで指定されている形式によって異なります。value
省略可能。関数コードの代わりに、IntelliSenseによって評価自体に対して使用する必要のあるコードを指定します。<field>の場合、この属性はコンストラクター関数ではサポートされますが、オブジェクト リテラルではサポートされません。フィールドの種類が未定義の場合に型情報が必要です。この属性を使用できます。たとえば、数としてフィールドの種類を処理するために value=’1’ を使用できます。description
省略可能。フィールドの説明。
解説
name の属性は、コンストラクター関数のフィールドを文書化する場合に必要です。他のすべてのシナリオでは、<field> の要素の属性はすべて省略可能です。
コンストラクター関数を記録している場合、<field> の要素は、フィールド宣言の直前に記述する必要があります。name の属性は、ソース・コードで使用されるフィールド名と一致する必要があります。オブジェクトのメンバーに、name の属性は <field> の要素がオブジェクトのメンバー宣言の直前にある省略できます。
使用例
次のコード例に <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;
}
次の例に trueに設定 static の属性の <field> の要素を使用する方法を示します。
function Engine() {
/// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}
Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.
次の例に falseに設定 static の属性の <field> の要素を使用する方法を示します。
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.
次の例に value の属性の <field> の要素を使用する方法を示します。
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.