JavaScriptのコメントアウトの使い方を現役エンジニアが解説【初心者向け】
初心者向けにJavaScriptのコメントアウトの使い方について現役エンジニアが解説しています。コメントアウトとは、プログラムに対するメモや付属事項を書いたり、プログラムをコメントにして無効にするためのものです。一行や複数行のコメントの使い方をみてみましょう。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日 調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名 調査手法:インターネット調査
この記事を書いた人
テックアカデミーマガジン編集部
JavaScriptのコメントアウトの使い方について解説します。
実際のコードをもとに解説していきますので、理解を深めていきましょう。
また、入門向けのJavaScriptを学習できるサイトも紹介しているので、合わせてご覧ください。
そもそもJavaScriptについてよく分からないという方は、JavaScriptとは何なのかについて解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプJavaScript/jQuery講座の内容をもとにしています。
今回は、JavaScriptに関する内容だね!
どういう内容でしょうか?
JavaScriptのコメントアウトの使い方について詳しく説明していくね!
お願いします!
コメントアウトとは
コメントとは、プログラムとして認識されないコードのことを指します。
通常はコードの説明やメモ、プログラムを一時的に無効化するといった目的で使用します。
コードをコメントにすることを、コメントアウトと言います。
JavaScriptのコメントアウトの使い方
JavaScriptのコメントにする場合は、1行のコメントと複数行のコメントの2パターンがあります。
1行のコメントは「//」を使用して、以下のように書きます。
// 足し算をする関数 function add (a,b) { return a + b };
複数行をコメントにする場合は、はじめに/*を、終わりに*/を記載します。
/* 足し算をする関数 引数: a ,b 戻り値: a+b */ function add (a,b) { return a + b };
JavaScriptのスクリプトをコメントアウトする理由
コメントを書く理由は、チームで開発する際にコードの役割や使い方を分かりやすく伝えるためです。
この引数の意味は何か、どんな型を使うのか、返り値は何かなどのコメントを残しておくことでコードを共有しやすくなります。
また、1人で開発する際にも過去に自分がどんな意図でコードを書いたのかを書き残すことで振り返った時に思い出しやすくなります。
実際に書いてみよう
それでは、実際にコードを書いてみましょう。
今回は1つ関数を作成して、コメントを記載してみます。
/* 引き算をする関数 引数: a,b 戻り値: a-b */ function sub (a,b) { return a-b };
適切なコメントを記載することで、開発効率をあげることができます。分かりやすい変数名や関数名も意識して、よりよいコードを書くようにしましょう。以上で開発を終わります。
内容が分かりやすくて良かったです!
ゆかりちゃんも分からないことがあったら質問してね!
分かりました。ありがとうございます!
TechAcademyでは、初心者でもJavaScript・jQueryを使ったWebサービス公開を習得できるオンラインブートキャンプJavaScript/jQuery講座を開催しています。
挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。