JavaScriptのコメントの書き方ガイド!1行・複数行コメントの基本と使い分け
生徒
「JavaScriptのプログラムの中に説明を書いておくことってできますか?」
先生
「できますよ。そういうときに使うのが『コメント』です。コメントは、プログラムの説明やメモとして使えるもので、実行には影響しません。」
生徒
「なるほど!どうやって書くんですか?」
先生
「では、JavaScriptでのコメントの書き方と使い分けについて詳しく解説していきましょう。」
1. JavaScriptのコメントとは?
JavaScriptの「コメント」とは、プログラムに説明やメモを書き残すための機能です。コメントに書かれた内容は、プログラムを動かすときに無視されます。つまり、コメントは「人間のための情報」であり、JavaScriptのコードには影響を与えません。
2. 1行コメントの書き方と使い方
1行コメントは、1行だけ説明を書きたいときに使います。//(スラッシュ2つ)を書いたところから、その行の終わりまでがコメントになります。
// これは1行コメントの例です
let name = "たろう"; // 名前を保存する変数
1行コメントは、コードの上や横にサッと説明を入れたいときにとても便利です。
3. 複数行コメントの書き方と使い方
複数行コメントは、長い説明や段落を書きたいときに使います。/*で始めて、*/で終わる範囲がコメントになります。
/*
これは複数行コメントの例です。
プログラムの流れや、処理の目的などを
詳しく書いておくと読みやすくなります。
*/
let age = 18;
複数行コメントは、関数の説明や処理の概要を書くときにとても役立ちます。
4. コメントの使いどころを知ろう
コメントを使うタイミングは以下のような場面です。
- 変数や定数の意味を説明するとき
- 複雑な処理の目的を説明したいとき
- あとで使うコードを一時的に無効にしたいとき
// 割引率の設定(将来変更するかも)
const DISCOUNT = 0.1;
// 一時的にこのコードは使わない
// let result = total * DISCOUNT;
このように、コメントは自分や他の人が後でコードを見返したときに、すぐに理解できるようにする大切な工夫です。
5. コメントを使うときの注意点
コメントはとても便利ですが、使いすぎや意味のないコメントには注意が必要です。
- コードの内容と同じことを繰り返すだけのコメントは不要
- コメントとコードの内容が違ってしまうと混乱の原因に
- コメントは短くても読みやすい日本語で
// ageに18を入れる ←これは無くてもいい説明
let age = 18;
// ユーザーが成人かどうかを判断するための年齢
let adultThreshold = 20;
意味のあるコメントを書くよう心がけると、コードの品質もぐっと上がります。
6. コメントでコードの読みやすさアップ!
コメントがあることで、プログラムは「読みやすく」「伝わりやすく」なります。初心者のうちは「書きながら説明する」気持ちでどんどんコメントを書いてOKです。
特に他人と一緒に作業するような場面では、コメントがあるだけで理解のスピードが全く違います。
/*
商品の合計金額を計算する処理
税率を含めて最終金額を出力する
*/
const price = 1000;
const tax = 0.1;
const total = price + price * tax;
console.log(total);
コメントは「プログラムに気持ちを込める手紙」と言われることもあります。ぜひ積極的に使ってみてください。
まとめ
JavaScriptコメントの基本を振り返ろう
ここまでの記事では、JavaScriptにおけるコメントの基本的な書き方から、1行コメントと複数行コメントの違い、そして実際にどのような場面で使うと効果的なのかを学んできました。コメントはプログラムの動作には直接関係しませんが、コードを読む人にとっては非常に重要な情報源です。特にJavaScriptのように記述が柔軟な言語では、処理の意図や背景をコメントで補足することで、理解しやすさが大きく変わります。
初心者のうちは「コメントは本当に必要なのだろうか」と感じることもあるかもしれません。しかし、時間が経ってから自分の書いたコードを見返したとき、コメントがあるかどうかで理解のスピードは大きく変わります。1行コメントは処理の横に短い説明を添えるのに向いており、複数行コメントは処理全体の目的や流れをまとめて伝えるのに適しています。
コメントを使い分けることの大切さ
コメントは「たくさん書けば良い」というものではなく、必要な場所に、必要な分だけ書くことが重要です。コードをそのまま読めば分かる内容をそのまま日本語にしただけのコメントは、逆に読みづらさの原因になります。一方で、なぜその処理が必要なのか、どんな前提で書かれているのかといった情報は、コメントとして残しておく価値があります。
また、1行コメントと複数行コメントを正しく使い分けることで、コード全体の見通しが良くなります。短い補足説明には1行コメント、まとまった説明や注意点には複数行コメントを使う、という意識を持つだけでも、JavaScriptのコードはぐっと読みやすくなります。
コメントを活用したシンプルなサンプル
// ユーザーの名前を保存する
let userName = "たろう";
/*
年齢をもとにメッセージを表示する処理
初心者にも分かりやすいようにコメントを追加
*/
let age = 18;
if (age >= 20) {
console.log("成人です");
} else {
console.log("未成年です");
}
このサンプルでは、1行コメントで変数の意味を説明し、複数行コメントで処理全体の目的をまとめています。処理自体は簡単でも、コメントがあることで「何をしたいコードなのか」がすぐに伝わるようになります。JavaScript学習の初期段階では、このようにコメントを書きながら理解を深めていく方法がおすすめです。
コメントは未来の自分と他の人へのメッセージ
コメントは、今そのコードを書いている自分だけのものではありません。数日後、数か月後の自分や、同じコードを読む他の人に向けたメッセージでもあります。JavaScriptのコメントを丁寧に書く習慣を身につけることで、プログラム全体の品質や信頼性も自然と高まっていきます。
最初は少し手間に感じるかもしれませんが、「あとで見たときに迷わないか」「初めて読む人でも理解できるか」を意識してコメントを書くことが、結果的に効率の良い開発につながります。
生徒
「JavaScriptのコメントって、ただの説明だと思っていましたが、読みやすさにこんなに影響するんですね。」
先生
「そうですね。特に1行コメントと複数行コメントを使い分けることで、コード全体の理解がとても楽になります。」
生徒
「後から自分で見返したときのためにも、コメントは大事だと感じました。」
先生
「その気づきはとても大切です。コメントは未来の自分へのヒントでもありますからね。」
生徒
「これからは、JavaScriptを書くときにコメントも一緒に考えるようにします。」
先生
「それができれば、読みやすくて伝わるコードが自然と書けるようになりますよ。」