Javascriptコメント

| | | | | | | | | | | | | | | | | | | |

JavaScriptコメントは、コードにメモを書き込んだり、コードのセクションを削除せずに無効にしたりするために使用されます。コメントはJavaScriptで作成され、 // 1行の前または / * 前と * / 複数行の後。

コメントコードは多くのプログラミング言語の基本的な機能です。コードコメントの背後にある考え方は、コードはコンピューターによって読み取られる一方で、人間によっても読み取られるということです。したがって、ユーザーが記述したコードを簡単に理解できることが重要です。

コメントを許可するプログラミング中にコードを追跡し、将来役立つ可能性のあるメモを取る機会を与えることができます。また、チームで作業している場合は、コメントを書くことで、作業に貢献する必要のある人なら誰でもコードを読みやすくすることができます。

このチュートリアルでは、コメントの書き方について説明します。 JavaScript。まず、JavaScriptでのコメントの価値について説明し、次にJavaScriptでコメントを書くために使用できる構文を見ていきます。

コードについてのコメント

について件名は、読み取り可能で管理しやすいコードを作成する上で不可欠な部分です。真実は、あなたが今日書いているコードを理解することができれば、それが明日何をするかを効果的に説明できるという保証はありません。また、他の人と一緒に作業している場合、他の人があなたが書いているコードの一部を理解していない可能性が非常に高くなります。

コメントの出番です。コメントは、コンパイラによって無視されるステートメントであり、 JavaScriptコードを説明するために使用できます。

開発者として、コードにコメントを書き込むと、実行していることをより効果的に追跡できます。コードを書くときに、コードをよりよく理解し、以前に書いたコードの背後にある意図を理解するのに役立つメモを書くことができます。コメントを書くことは、あなたのコードを見る可能性のある他の人々にも役立ちます。コメントは、おそらくあなたのコードがどのように機能するかをより深く理解するのに役立つからです。

各開発者は異なる方法でコメントを書き込みますが、一般的なルールコメントは、コードの背後にある意図を説明するために使用する必要があるということです。結局のところ、コードはそれ自体を物語っていますが、コードを特定の方法で書く理由は、多くの場合そうではありません。したがって、コメントを書くことで、なぜあなたが特定の方法で問題が発生し、後でプログラムがどのように機能するかを他の人が理解しやすくなります。

JavaScriptコメント

JavaScriptで使用されるコメントには次の2種類があります。単一行コメントとブロックコメント

単一行コメントは、2つのスラッシュ(//)を使用して記述され、1行のコードに記述されます。 "//"宣言に続く文字は、行末まで無視されます。 JavaScriptでの1行コメントの例を次に示します。

//これは行コメントです

ブロックはオープニングとタグを閉じて、コメントを複数行として書き込むことができます。ブロックコメントの開始タグと終了タグは次のとおりです。

ブロックコメントは複数行コメントと呼ばれることもあり、複数行のCSSコメントのように見えます。 JavaScriptでのブロックコメントの例を次に示します。

開始タグと終了タグの間のすべてのコードは、コンパイラによって無視されます。

任意の種類のコメントを使用して、コードを説明し、コードの背後にある意図について説明できます。コード。基本的な変数宣言を説明するコメントの例を次に示します。

//「チョコレート」変数を宣言してチョコレートの種類を配列として格納する

varchocolate = [`Dark` 、`Milk`、`White`、`hazelnuts`、`Caramel`];

すべてのプログラミング言語のコメントは、コードの変更に応じて頻繁に更新する必要があります。したがって、変数名の名前を「chocolate_types」に変更することにした場合は、コメントを更新して、新しい変数名が反映されていることを確認する必要があります。実際、プログラムは大きくなり、大幅に変更されることが多いため、更新することが重要です。コメントとコード

コメントコード

コメントは、多くの場合、2つの目的のいずれかで使用されます。 1つ目は、この記事で説明したように、コードの背後にある意図を説明し、混乱を解消することです。 2つ目は、テスト中にコードが実行されないようにすることです。

コードにコメントを付けると、プログラムからコードを完全に削除せずに、1行以上のコードの実行を中断できます。問題のいくつかの解決策を試し、後で使用するためにコードを保存できるため、デバッグ時にはコメントが一般的です。

コード行をコメントアウトするコメントの例を次に示します。

プログラムを実行すると、コンパイラは変数を宣言するコード行を実行します。"flavors"<をコメントアウトしました。 / code>にはエラーが含まれており、問題をデバッグする必要があるためです。この場合、変数名( "flavors")と変数の値(フレーバー範囲)の間に等号を入れるのを忘れました。

それぞれを分類します。

単一行コメント

単一行コメントは、インラインコメントとも呼ばれ、一部をコメントアウトするために使用されます。コードの行またはコードでいっぱいの行の。 1行のJavaScriptコメントの例を次に示します。

このコメントでは、最初の値を "first_type"変数を宣言します>「チョコレート」テーブル。次に、行の最後にインラインコメントを追加して、コードの背後にある意図を説明します。

通常、1行のコメントは、コードに関する簡単なコメントを作成したり、コードの背後にある意図を説明したりするために使用されます。特定のコード行。ただし、使用する必要があるコメントのタイプは1行のコメントだけではありません。より大きな関数を説明する必要がある場合は、ブロックコメントを記述するのが最適です

一括コメント

一括コメントは複数行に渡って記述され、コードの大部分を説明するために使用されます。通常、1行のコメントはコードの行を説明しますが、コメントブロックは関数またはファイルの関数。

複数行は関数またはファイルの先頭から始まります。ほとんどの場合、ループを説明するために使用されるブロックコメントの例を次に示します。

ブロックコメントはreのt行にまたがり、「for」ループで10個記述されたコードを説明するために使用されます。

ブロックコメントは最初にもあります。ファイルの目的を説明するため、またはファイルの作成者とバージョンに関する情報を含めるためのファイルの。次に、ファイルの作成者とJavaScriptでの作成日を含むスニペットの例を示します。

結論

コードにコメントを書き込むと、より読みやすく保守しやすいコードを記述できます。コメントを使用して、将来的に自分でコードを追跡し、コードを操作する他の人がその目的を理解しやすくすることができます。

このチュートリアルでは、コメントの基本と、JavaScriptコメントの書き方を探りました。また、コメントの2つの主要なタイプ(単一行と複数行)についても説明し、実際の各タイプのコメントコードの例を示します。最後に、コメントとコードコメントの違いについて説明しました。

これで、エキスパートのようにJavaScriptコメントを書く準備ができました!