コメントの書き方

このレッスンでは、JavaScriptにおけるコメントの書き方を学び、あとから読み返しても分かりやすいコードを書けるようになることを目標にします。「JavaScript コメントアウト 書き方」で検索している初心者の方向けの内容です。

コメントは、プログラムの動作には影響しない「人間向けのメモ書き」です。あとで自分や他の人がコードを読んだときに分かりやすくするために書きます。//で1行、/* */で複数行のコメントになります。コメントの中に書いたコードは実行されないため、一時的にコードを無効化する(コメントアウトする)ためにもよく使われます。

サンプルコードでは、1行コメントで変数の説明を加え、複数行コメントでまとまった説明を書いています。// 商品の価格(円)のように、変数の右側や上に短い説明を添える書き方は、実務でも非常によく使われるスタイルです。コメントは日本語でも英語でも構いませんが、チームのルールに合わせるのが基本です。

初心者がよくつまずくのが、コメントを書きすぎてしまい、かえってコードが読みにくくなるケースです。「何をしているか」はコード自体を読めば分かることが多いため、コメントには「なぜこの処理が必要なのか」という背景を書くのが効果的です。逆に複雑な処理には積極的にコメントを添えるべきで、量より質を意識しましょう。

実際の開発現場では、チームで開発するときにコメントの有無が大きな差を生みます。数か月後の自分やチームメンバーがコードを見返したときに、意図が伝わるコメントが残っていると、修正やバグ調査のスピードが大きく変わります。コメントの書き方は、実務でのコーディングスキルの一部として評価される要素です。

コードエディタによっては、選択した範囲を一括でコメントアウトするショートカットキーが用意されていることが多く、動作確認のために一時的にコードを無効化したいときにとても便利です。積極的に活用してみましょう。

JSDocと呼ばれる特別な形式のコメント(/** ... */で関数の説明・引数・戻り値を記述する書き方)を使うと、多くのエディタが自動的に関数の説明をポップアップ表示してくれるようになり、チーム開発での効率が向上します。