JavaScript の@Param タグ

  2. プログラミングのヒント
  3. JavaScript ハウツー
  4. JavaScript の@Param タグ
Muhammad Muzammil Hussain 2023年10月12日
JavaScript JavaScript Tag
JavaScript の@Param タグ

この記事では、JavaScript ソースコードで@param タグを学習して使用します。このタグは、ソースコードのドキュメント化に使用されます。

これらのタイプのタグは、プログラマーがコードの実行フローを理解するのに役立ちます。

JavaScript の@param タグ

JavaScript ソースコードのドキュメントでは、@param タグは、名前、タイプ、説明などの関数パラメータのさまざまな詳細を提供します。 @param タグには、関数パラメータの説明があります。

@param タグを区切ると、3つの部分に分割されます。

  1. 1つ目は、中括弧 {} 内にあります。これは、パラメーターのデータタイプを定義するために使用できます。
  2. 2 番目はパラメータの名前です。
  3. 最後の部分は、ハイフン - 記号で区切られたパラメーターの説明です。

@param の基本構文：

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

@param タグでは、開発者が標準ごとにパラメータの詳細を定義する必要があります。これらの標準に従ってパラメータの説明を提供すると、JavaScript ドキュメントのコメントをより読みやすく理解しやすくすることができます。

パラメータは組み込みの JavaScript タイプにすることができます。文字列またはオブジェクトにすることができます。

プロパティを持つパラメータ

パラメータが特定のプロパティを持つと予想されるとします。さらに@param タグを付けて文書化できます。Student パラメータに名前とクラスのプロパティが含まれている場合は、次のように文書化できます。

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