Etiqueta @Param en JavaScript

En este artículo, aprenderemos y usaremos la etiqueta @param en el código fuente de JavaScript. Esta etiqueta se utiliza para la documentación de un código fuente.

Estos tipos de etiquetas son útiles para que los programadores comprendan el flujo de ejecución del código.

la etiqueta @param en JavaScript

En la documentación del código fuente de JavaScript, las etiquetas @param proporcionan los diversos detalles de los parámetros de la función, como el nombre, el tipo y la descripción. La etiqueta @param aparece con la descripción de los parámetros de la función.

Si separamos la etiqueta @param, se dividirá en tres partes.

1. Primero está entre llaves {}, que se pueden usar para definir el tipo de datos del parámetro.
2. El segundo es el nombre de un parámetro.
3. La última parte es la descripción del parámetro con la separación del signo de guión -.

La sintaxis básica de @param:

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

La etiqueta @param requiere que los desarrolladores definan los detalles de los parámetros según los estándares. Proporcionar descripciones de parámetros de acuerdo con esos estándares puede hacer que los comentarios de documentos de JavaScript sean más legibles y comprensibles.

El parámetro puede ser un tipo de JavaScript incorporado; puede ser una cadena u objeto.

Parámetros con propiedades

Suponga que se prevé que el parámetro tenga una propiedad específica. Podemos documentarlo con una etiqueta adicional @param; si un parámetro de estudiante contiene propiedades de nombre y clase, podemos documentarlo como se muestra a continuación.

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

Parámetros con devolución de llamada

Podemos usar la etiqueta @callback para definir un tipo de devolución de llamada si el parámetro acepta una función de devolución de llamada. Después de eso, podemos incluir el tipo de devolución de llamada en la etiqueta @param, como se muestra a continuación.

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