Balise @Param en JavaScript

Dans cet article, nous allons apprendre et utiliser la balise @param dans le code source JavaScript. Cette balise est utilisée pour la documentation d’un code source.

Ces types de balises sont utiles aux programmeurs pour comprendre le flux d’exécution du code.

la balise @param en JavaScript

Dans la documentation du code source JavaScript, les balises @param fournissent les différents détails des paramètres de fonction tels que le nom, le type et la description. La balise @param revient avec la description des paramètres de la fonction.

Si nous séparons la balise @param, elle se divisera en trois parties.

1. Le premier est entre accolades {}, qui peut être utilisé pour définir le type de données du paramètre.
2. Le second est le nom d’un paramètre.
3. La dernière partie est la description du paramètre avec la séparation du signe tiret -.

La syntaxe de base de @param :

/**
 * @param {data type of param} param name - description of param.
 */
function functionName(paramName) {
  alert('Hello ' + paramName);
}

La balise @param oblige les développeurs à définir les détails des paramètres selon les normes. Fournir des descriptions de paramètres conformes à ces normes peut rendre les commentaires de documentation JavaScript plus lisibles et compréhensibles.

Le paramètre peut être un type JavaScript intégré ; il peut s’agir d’une chaîne ou d’un objet.

Paramètres avec propriétés

Supposons que le paramètre est censé avoir une propriété spécifique. Nous pouvons le documenter avec une autre balise @param ; si un paramètre étudiant contient des propriétés de nom et de classe, nous pouvons le documenter comme indiqué ci-dessous.

<script>
/**
 * Assign the class to the student.
 * @param {Object} student - The student who is a part of class.
 * @param {string} student.name - The name of the student.
 * @param {string} student.class - The student's class.
 */
function studentData(student) {
    // rest operation of function
};
</script>

Paramètres avec rappel

Nous pouvons utiliser la balise @callback pour définir un type de rappel si le paramètre accepte une fonction de rappel. Après cela, nous pouvons inclure le type de rappel dans la balise @param, comme indiqué ci-dessous.

<script>
/**
 * @callback callbackRequest
 * @param {number} statusCode
 * @param {string} message
 */

/**
 * asynchronous task and on completion executes the callback.
 * @param {callbackRequest} callBack - The callback for handle the result.
 */
function asynchronousTask(callBack) {
    // rest operation of function
};
</script>