<param> (JavaScript)
Specifica le informazioni di documentazione per un parametro in una funzione o un metodo.
<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>
Parametri
name
Necessario.Nome del parametro.type
Opzionale.Tipo di dati del parametro.Il tipo può essere:Un linguaggio ECMAScript nella specifica di ECMAScript 5, come Number e Object.
Un oggetto DOM, come HTMLElement, Windowe Document.
Una funzione costruttore JavaScript.
integer
Opzionale.Se type è Number, specifica se il parametro è un Integer.Impostare su true per indicare che il parametro è un Integer, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.domElement
Opzionale.Questo attributo è stato deprecato; l'attributo type ha la precedenza su questo attributo.Questo attributo specifica se il parametro è documentato un elemento DOM.Impostare su true per specificare che il parametro è un elemento DOM; in caso contrario, insieme a false.Se l'attributo type non è impostato e domElement è impostato su true, IntelliSense considera il parametro come documentato HTMLElement durante il completamento delle istruzioni.mayBeNull
Opzionale.Specifica se il parametro documentato può essere impostato su null.Impostare su true per indicare che il parametro può essere impostato su null; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.elementType
Opzionale.Se type è Array, questo attributo specifica il tipo degli elementi nella matrice.elementInteger
Opzionale.Se type è Array e elementType è Number, questo attributo consente di specificare se gli elementi nella matrice di Integer.Impostare su true per indicare che gli elementi nella matrice di Integer, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.elementDomElement
Opzionale.Questo attributo è stato deprecato; l'attributo elementType ha la precedenza su questo attributo.Se type è Array, questo attributo consente di specificare se gli elementi nella matrice sono elementi DOM.Impostare su true per specificare che gli elementi sono elementi DOM, in caso contrario, insieme a false.Se l'attributo elementType non è impostato e elementDomElement è impostato su true, IntelliSense considera ogni elemento della matrice come HTMLElement durante il completamento delle istruzioni.elementMayBeNull
Opzionale.Se type è Array, specifica se gli elementi nella matrice possono essere impostati su null.Impostare su true per indicare che gli elementi nella matrice possono essere impostati su null; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.locid
Opzionale.L'identificatore per informazioni sulla localizzazione sul parametro.L'identificatore è un membro o ID o corrisponde al valore di attributo name in un gruppo di messaggio definito dai metadati di OpenAjax.Il tipo dell'identificatore dipende dal formato specificato nell'elemento <loc> (JavaScript).parameterArray
Opzionale.Specifica se il parametro documentato può essere ripetuto nella chiamata di funzione, simile ai parametri ripetuti di supporto nella funzione String.format.Impostare su true per indicare che il parametro può essere ripetuto, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.optional
Opzionale.Specifica se il parametro facoltativo è documentato nella funzione chiamante.Impostare su true per indicare che il parametro è facoltativo, in caso contrario, insieme a false.value
Opzionale.Specifica il codice che deve essere valutato da IntelliSense anziché il codice della funzione.È possibile utilizzare questo attributo è necessario fornire le informazioni sul tipo al tipo di parametro definito.Ad esempio, è possibile utilizzare value=’1’ per gestire il tipo di parametro come numero.description
Opzionale.Descrizione del parametro.
Note
L'unico attributo è obbligatorio name.Tutti gli altri attributi sono facoltativi.
Gli elementi utilizzati per annotare le funzioni, come <summary> (JavaScript), <param> (JavaScript)e <returns> (JavaScript), devono essere inseriti nel corpo della funzione prima delle istruzioni.
Se sono presenti più elementi <param> con lo stesso nome, uno degli elementi <param> viene utilizzato ed elementi ridondanti vengono ignorati.Il comportamento che determina quale elemento viene utilizzato non è definito.Se name si riferisce a un parametro non esistente, l'elemento viene ignorato.
Esempio
Le esempio di codice seguente viene illustrato come utilizzare l'elemento <param>.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when provided a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}
// Uses of <param> with the value attribute.
function calculate(a) {
/// <param name='a' value='1'/>
a. // Completion list for a Number.
}
function calculate(a) {
/// <param name='a' value='{x:0,y:0}'/>
a. // x and y appear in the completion list.
}