JavaScript 中的 @Param 标记

Muhammad Muzammil Hussain 2023年10月12日 JavaScript JavaScript Tag
JavaScript 中的 @Param 标记

在本文中，我们将学习和使用 JavaScript 源代码中的 @param 标签。此标签用于源代码的文档。

这些类型的标签有助于程序员了解代码的执行流程。

JavaScript 中的 @param 标签

在 JavaScript 源代码文档中，@param 标签提供了函数参数的各种详细信息，例如名称、类型和描述。 @param 标签带有函数参数的描述。

如果我们将@param 标签分开，它将分为三个部分。

  1. 首先是大括号 {} 内，可用于定义参数的数据类型。
  2. 第二个是参数的名称。
  3. 最后一部分是参数的描述，用连字符 - 符号分隔。

@param 的基本语法：

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

@param 标记要求开发人员根据标准定义参数详细信息。根据这些标准提供参数描述可以使 JavaScript 文档注释更具可读性和可理解性。

参数可以是内置的 JavaScript 类型；它可以是字符串或对象。

带属性的参数

假设参数预计具有特定属性。我们可以用另一个@param 标签记录它；如果学生参数包含名称和类属性，我们可以将其记录下来，如下所示。

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

带回调的参数

如果参数接受回调函数，我们可以使用@callback 标签来定义回调类型。之后，我们可以在@param 标签中包含回调类型，如下所示。

<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>
Enjoying our tutorials? Subscribe to DelftStack on YouTube to support us in creating more high-quality video guides. Subscribe