JavaScriptのコメントアウトの書き方を現役エンジニアが解説【初心者向け】

初心者向けにJavaScriptのコメントアウトの書き方について現役エンジニアが解説しています。コメントアウトとは、プログラムに対するメモや付属事項を書いたり、コメントアウトして無効にするためのものです。一行や複数行のコメントの書き方をみてみましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,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
};

 

[PR] JavaScript・jQueryで挫折しない学習方法を動画で公開中

JavaScriptのスクリプトにコメントアウトする理由

コメントアウトを書く理由は、チームで開発する際にコードの役割や使い方を分かりやすく伝えるためです。

この引数の意味は何か、どんな型を使うのか、返り値は何かなどのコメントを残しておくことでコードを共有しやすくなります。また、1人で開発する際にも過去に自分がどんな意図でコードを書いたのかを書き残すことで振り返った時に思い出しやすくなります。

実際に書いてみよう

それでは、実際にコードを書いてみましょう。今回は1つ関数を作成して、コメントを書いてみます。

/*
引き算をする関数
引数: a,b
戻り値: a-b
*/
function sub (a,b) {
  return a-b
};

適切なコメントをつけることで、開発効率をあげることができます。分かりやすい変数名や関数名も意識して、よりよいコードを書くようにしましょう。以上で開発を終わります。

筆者プロフィール

メンター金成さん

2014年より、某物流会社のシステム開発担当として入社。

未経験ながら、社内システム保守~新規受注システム開発まで携わり、JavaScript Ruby on Rails PostgreSQLなどの経験を積む。現在も、開発案件に携わりながら、日々勉強中。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間でJavaScript・jQueryを使ったWebサービス公開を習得できるオンラインブートキャンプJavaScript/jQuery講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。