2008-11-11 17 views

Respuesta

13

Una excelente entrada de blog de Bertrand LeRoy en formato de IntelliSense para JavaScript: The format for JavaScript doc comments.

En pocas palabras:

Resumen - usado para describir una función/método o evento. Sintaxis:

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

Parámetro - describe un parámetro para una función/método. Sintaxis:

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

La etiqueta param se usa para describir los parámetros de un método o constructor. Las etiquetas param deben estar en el mismo orden que el método o los parámetros del constructor y tienen los mismos nombres.

Función tipo de retorno - sintaxis:

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

Tipo de valor - describe una propiedad (uso shouldnt 'Resumen' para un prop) - sintaxis:

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

campo - se usa para describir un campo en una clase de JavaScript - sintaxis:

<field name="fieldName" type="FieldType" 
    integer="true|false" domElement="true|false" mayBeNull="true|false" 
    elementType="ArrayElementType" elementInteger="true|false" 
    elementDomElement="true|false" elementMayBeNull="true|false" 
    locid="descriptionID">Description</field> 

cómo incluir IntelliSense para un archivo JavaScript externo, t lo siguiente sintaxis como la primera línea (s) en un archivo JavaScript:

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