JavaScriptを一から理解する: コメントについて
はじめに
はじめまして、Doxperと申します。
今回はJavaScriptにおけるコメントの書き方をご紹介します。
この記事でできるようになること
- コメントはどういったものか理解することができる。
- なぜコメントが必要なのか分かる。
- JavaScriptにおけるコメントの書き方を学ぶことができる。
対象読者
- エンジニアを目指している同士
- JavaScriptの基礎を身につけたい方
- 過去にプログラミング学習に挫折した方
- プログラミング言語は他に触ったことがない方
JavaScript Comments
コメントとは簡単に説明すると、コードの可読性を高めるための説明文です。
コメントはプログラムを実行しているユーザーが見ることを意図しておらず、プログラムとして評価されません。
JavaScriptにおけるコメントの書き方は主に二種類あります。(厳密には5種類もあるみたいです)
-
//一行コメント -
/* */複数行コメント
一行コメント
//これは一行コメントです
//この部分は評価されません。
複数行コメント
/*
これは複数行コメントです。
囲まれている範囲は全て
コードとして評価されません。
*/
わかりやすいコメントを書くために
ここでは見やすいコメントの書き方、種類についてご紹介します。
早速例に移りましょう。
コメントを書く時は説明したいコードの上に書くのが一般的です。
//良い例
//コンソールに'Hello, World!'と表示
console.log('Hello, World!');
//悪い例
console.log('Hello, World!');
//コンソールに'Hello, World!'と表示
コメントを書くときはインデントも合わせましょう。
//greetUser関数を定義
function greetUser() {
//ユーザー名を定数nameに代入
const name = prompt("What's your name?");
//コンソールにユーザー名を表示
console.log(`Hello, ${name}!`);
}
コード行の末尾に書くコメントをインラインコメントと呼びます。
let num1 = 10; //変数num1を初期化
let num2 = num1 + 10; // 変数num2にnum1と10の和を代入
コメントアウト
コメントはコードを説明するために書かれると前述しましたが、もう一つ重要な役割としてテストやデバッグのために使われることがあります。このことを一般的にコメントアウトと呼びます。
コードに何かしら問題がある場合、一行または複数行をコメントアウトします。
コメントアウトした後に問題が修正された場合、コードのどこに問題があるか知ることができます。
console.log("some code");
// console.log("Error code);
console.log("other code");
おわりに
いかがでしたでしょうか？
今回はJavaScriptにおけるコメントの書き方についてまとめてみました。
JavaScriptのコードはコンピューターによって解釈されますが、未来の自分を含む他のエンジニアによって常に読まれることになります。
適切なコメントを残すことはエンジニアにとって必須のスキルなので、誰かに読まれることを常に意識をしてコードを書いていきたいと思います。
また、記事について間違っている点やよりよい表現などの提案などありましたらご気軽にコメントいただけますと幸いです。
それではまた次回の記事でお会いしましょう👋
参考文献
What is a Comment?
コメント · JavaScript Primer #jsprimer
How To Write Comments in JavaScript | DigitalOcean
Learn JavaScript Programming
JavaScript Comments
Discussion