@Param-Tag in JavaScript

In diesem Artikel lernen und verwenden wir das @param-Tag im JavaScript-Quellcode. Dieses Tag dient der Dokumentation eines Quellcodes.

Diese Arten von Tags sind für Programmierer nützlich, um den Ausführungsfluss von Code zu verstehen.

das @param-Tag in JavaScript

In der JavaScript-Quellcode-Dokumentation stellen @param-Tags die verschiedenen Details von Funktionsparametern wie Name, Typ und Beschreibung bereit. Das Tag @param enthält die Beschreibung der Funktionsparameter.

Wenn wir das @param-Tag trennen, wird es in drei Teile geteilt.

1. Das erste steht in geschweiften Klammern {}, mit denen der Datentyp des Parameters definiert werden kann.
2. Der zweite ist der Name eines Parameters.
3. Der letzte Teil ist die Beschreibung des Parameters mit Trennzeichen durch Bindestrich -.

Die grundlegende Syntax von @param:

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

Das @param-Tag fordert Entwickler auf, die Parameterdetails pro Standard zu definieren. Die Bereitstellung von Parameterbeschreibungen gemäß diesen Standards kann JavaScript-Dokumentkommentare lesbarer und verständlicher machen.

Der Parameter kann ein integrierter JavaScript-Typ sein; es kann eine Zeichenfolge oder ein Objekt sein.

Parameter mit Eigenschaften

Angenommen, der Parameter soll eine bestimmte Eigenschaft haben. Wir können es mit einem weiteren @param-Tag dokumentieren; Wenn ein Schülerparameter Namens- und Klasseneigenschaften enthält, können wir ihn wie unten gezeigt dokumentieren.

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

Parameter mit Rückruf

Wir können das Tag @callback verwenden, um einen Callback-Typ zu definieren, wenn der Parameter eine Callback-Funktion akzeptiert. Danach können wir den Callback-Typ in das @param-Tag einfügen, wie unten gezeigt.

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