JavaScript 中的 @Param 標記

Muhammad Muzammil Hussain 2023年10月12日

JavaScript JavaScript Tag

在本文中，我們將學習和使用 JavaScript 原始碼中的 @param 標籤。此標籤用於原始碼的文件。

這些型別的標籤有助於程式設計師瞭解程式碼的執行流程。

JavaScript 中的 `@param` 標籤

在 JavaScript 原始碼文件中，@param 標籤提供了函式引數的各種詳細資訊，例如名稱、型別和描述。 @param 標籤帶有函式引數的描述。

如果我們將@param 標籤分開，它將分為三個部分。

首先是大括號 {} 內，可用於定義引數的資料型別。
第二個是引數的名稱。
最後一部分是引數的描述，用連字元 - 符號分隔。

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

JavaScript 中的 @param 標籤

帶屬性的引數

帶回撥的引數

JavaScript 中的 `@param` 標籤