2008-11-11 7 views

Antwort

13

Ein ausgezeichnetes Blog-Posting von Betrand LeRoy auf IntelliSense-Format für JavaScript: The format for JavaScript doc comments.

Auf den Punkt gebracht:

Zusammenfassung - verwendet, um eine Funktion/Methode oder ein Ereignis zu beschreiben. Syntax:

<summary locid="descriptionID">Description</summary> 

Parameter - beschreibt einen Parameter für eine Funktion/Methode. Syntax:

<param name="parameterName" 
    mayBeNull="true|false" optional="true|false" 
    type="ParameterType" parameterArray="true|false" 
    integer="true|false" domElement="true|false" 
    elementType="ArrayElementType" elementInteger="true|false" 
    elementDomElement="true|false" 
    elementMayBeNull="true|false">Description</param> 

PARAM-Tag wird verwendet, um die Parameter einer Methode oder Konstruktor zu beschreiben. Die param-Tags sollten in der gleichen Reihenfolge wie die Parameter der Methode oder des Konstruktors sein und dieselben Namen haben.

Funktion Rückgabetyp - Syntax:

<returns 
    type="ValueType" integer="true|false" domElement="true|false" 
    mayBeNull="true|false" elementType="ArrayElementType" 
    elementInteger="true|false" elementDomElement="true|false" 
    elementMayBeNull="true|false">Description</returns> 

Werttyp - beschreibt eine Eigenschaft (shouldnt Verwendung 'Zusammenfassung' für eine Stütze) - Syntax:

<value 
    type="ValueType" integer="true|false" domElement="true|false" 
    mayBeNull="true|false" elementType="ArrayElementType" 
    elementInteger="true|false" elementDomElement="true|false" 
    elementMayBeNull="true|false" 
    locid="descriptionID">Description</value> 

Field - verwendet, um ein Feld zu beschreiben in einer JavaScript-Klasse - Syntax:

So fügen Sie IntelliSense für eine externe JavaScript-Datei ein, t er folgende Syntax als die erste Zeile (n) in einer JavaScript-Datei:

<reference path="path/to/the/script/reference.js" 
    assembly="Assembly.Name" name="ScriptResourceName.js"/> 
Verwandte Themen