JavaScript のいくつかのコメント文字について話しましょう

JavaScript は広く使用されているプログラミング言語です。注釈は、開発者がコードの可読性、保守性、再利用性を向上させるのに役立つ非常に重要な機能です。コメントは実行されない特別なステートメントですが、コードに関する追加情報を他の人に伝えることができます。 JavaScript にはさまざまなコメント文字が用意されていますが、この記事では、これらのコメントとその適用可能なシナリオを紹介します。

1. 単一行コメント (//)

単一行コメントでは、「//」文字を使用して、コードの行末にあるコード行をコメントします。コード。例:

var num1 = 10;
var num2 = 20; //这里是注释，说明这个变量用途

1 行のコメントで、1 行のコード内の複数のステートメントをコメントすることもできます。例:

var a = 1; //变量a
var b = 2; //变量b
var c = a + b; //计算a+b
console.log(c); //输出c的值

単一行コメントは、変数の目的や関数の機能の簡単な説明など、コードに関する短いコメントに適しています。

2. 複数行のコメント (/ /)

複数行のコメントは、/ / を使用して複数行を折り返します。コード。コメントはコードに影響を与えてはなりません。例:

/* 这里是多行注释
可以在其中写入多行
代码 */
var num1 = 10;
var num2 = 20;

複数行コメントは、関数の実装やコード セグメントの関数など、長いコード部分にコメントを付けるのに適しています。

3. ドキュメント コメント (/* /)

ドキュメント コメントは、特殊なタイプの複数行コメントです。 「/*」で始まり「/」で終わります。ドキュメントのコメントには、パラメーター、戻り値、その他の情報を含む、関数、クラス、またはオブジェクトの説明情報を含めることができます。例:

/**
 * 计算两个数之和
 * @param {number} x 第一个数
 * @param {number} y 第二个数
 * @returns {number} 返回两个数之和
 */
function sum(x, y) {
  return x + y;
}

ドキュメント コメントは、他の人がコードを読みやすく使用できるように API ドキュメントを作成するのに適しています。

上記の 3 つのコメントに加えて、他のコメント メソッドもあります。

4. '@license' comment

JavaScript を記述するときコードはオープンソースであるため、ファイルの先頭に「@license」などのコメントを追加して、コードで使用されるライセンスを宣言する必要があります。例:

/*
 * @license
 * My Project v1.0.0
 * (c) 2022 My Name <me@example.com>
 * License: MIT
 */

5. '@param' アノテーション

コード内に関数を記述し、その関数にパラメーターがある場合、「@param」を使用できます。各パラメータの種類と役割を説明する注釈。例:

/**
 * 计算两个数之和
 * @param {number} x 第一个数
 * @param {number} y 第二个数
 * @returns {number} 返回两个数之和
 */
function sum(x, y) {
  return x + y;
}

6. '@returns' アノテーション

作成した関数が値を返す場合、「@returns」アノテーションを使用して戻り値を識別できます。関数のタイプ。例:

/**
 * 计算两个数之和
 * @param {number} x 第一个数
 * @param {number} y 第二个数
 * @returns {number} 返回两个数之和
 */
function sum(x, y) {
  return x + y;
}

コメントを書くときは、コメントとコードの一貫性を保つことに注意してください。適切なコメント方法をマスターすると、コードの読みやすさと保守性が大幅に向上します。同時に、コードを設計するときは他の人の読み方や使用法を考慮する必要があり、標準化されたコメントを書くこともコーディングの良い習慣となります。

以上がJavaScript のいくつかのコメント文字について話しましょうの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。