共用方式為


<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> 項目直接 pragma 欄位時,這個屬性會被忽略,因此, Visual Studio 會使用名稱為實際欄位名稱的原始程式碼的。

  • static
    選擇項。 指定欄位是否為建構函式的成員或建構函式傳回之物件的成員。 設計階段視為欄位的 true 的集合做為建構函式的成員。 設計階段視為欄位的 false 的集合,物件的成員是由建構函式傳回。

  • type
    選擇項。 欄位的資料型別。 型別可以是下列其中一項:

    • ECMAScript 語言類型 ECMAScript 的規格,例如 NumberObject

    • DOM 物件,例如 HTMLElementWindowDocument

    • JavaScript 建構函式。

  • integer
    選擇項。 如果 type 是 Number,指定欄位是否為整數。 設定為 true 表示欄位是整數;否則,設定為 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • domElement
    選擇項。 這個屬性已被取代; type 屬性優先於這個屬性。 這個屬性指定記錄的欄位是否為 DOM 項目。 設定為 true 指定欄位是 DOM 項目;否則,設定為 false。 如果 type 屬性未設定,而且 domElement 設為 true, IntelliSense 會將文件的欄位當做 HTMLElement ,當執行陳述式完成時。

  • mayBeNull
    選擇項。 指定文件的欄位是否可以設定為 null。 設定為 true 某個欄位可以設定為 null;否則,設定為 false。 預設值是 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • elementType
    選擇項。 如果 type 是 Array,這個屬性在陣列指定之項目的型別。

  • elementInteger
    選擇項。 如果 type 是 Array ,並 elementType 是 Number,這個屬性指定陣列中的項目是否為整數。 設定為 true 表示陣列中的項目是整數;否則,設定為 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • elementDomElement
    選擇項。 這個屬性已被取代; elementType 屬性優先於這個屬性。 如果 type 是 Array,這個屬性指定陣列中的項目是否為 DOM 項目。 設定為 true 指定項目是 DOM 項目;否則,設定為 false。 如果 elementType 屬性未設定,而且 elementDomElement 設為 true, IntelliSense 會將陣列中的每個項目做為 HTMLElement ,當執行陳述式完成時。

  • elementMayBeNull
    選擇項。 如果 type 是 Array,指定陣列中的項目是否可以設定為 null。 設定為 true 表示陣列中的項目可以設定為 null;否則,設定為 false。 預設值是 false。 Visual Studio 不會使用這個屬性提供 IntelliSense 資訊。

  • helpKeyword
    選擇項。 F1 說明的關鍵字。

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

  • value
    選擇項。 指定應該評估供 IntelliSense 而不是函式程式碼的程式碼。 對於 <field>,這個屬性為建構函式支援,不過,不會針對物件常值支援。 當欄位型別未定義時,您可以使用這個屬性要提供型別資訊。 例如,您可以使用 value=’1’ 視為欄位型別為數字。

  • description
    選擇項。 欄位的描述。

備註

name 屬性,當您記錄建構函式的欄位時,內需要。 對於其他案例, <field> 項目的所有屬性都是選擇性的。

當您記錄建構函式時, <field> 項目必須在欄位宣告之前出現。 name 屬性必須符合用於原始程式碼的欄位名稱。 對於物件成員,則為,否則 <field> 項目在物件成員宣告之前,會出現 name 屬性可以省略。

範例

下列程式碼範例示範如何使用 <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;
}

下列範例顯示如何使用與 static 屬性的 <field> 項目設定為 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.  

下列範例顯示如何使用與 static 屬性的 <field> 項目設定為 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.  

下列範例顯示如何使用與 value 屬性的 <field> 項目。

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

請參閱

概念

XML 文件註解 (JavaScript)