javascriptのコメントアウトについて知りたい。
未経験者にも分かりやすく教えてほしい。
上記のお悩みを解決します。
■本記事の内容
本記事で以下の内容をお伝えします。
・コメントアウトを使用するときはどういった時？
・基本的にどのプログラミングにもコメントアウトがある
■本記事の信頼性
この記事を書いている私は、プログラミングを仕事として始めて10年以上ほど経ちます。今も現役のシステムエンジニアです。
プログラミング初心者向けにjavascriptのコメントアウトの書き方について説明していきます。
javascriptに限らずコメントアウトはどのプログラミング言語にも存在します。
コードを作成する上でよく使用するので、一度どういったものか理解しておくと良いでしょう。
javascriptのコメントアウトの書き方
コメントアウトは、いわゆるコード内に記載するメモみたいなものです。
コメントアウトされている内容はプログラムとしては無視される状態になります。
書き方は1行だけコメントアウトする書き方と複数行コメントアウトする書き方が存在します。
1行コメント
1行コメントの場合は以下のように書きます。
// テストコードです
const a = "test";
console.log(a);// と書かれているのがコメントアウトする書き方です。
通常上記の「テストコードです」をそのまま書いてしまうとエラーになりますが、この // をはじめにつけることで後ろの内容はプログラムとして処理対象とはしない形になります。
// がついてない2行目と3行目だけ実行されるイメージです。
複数行コメント
続いて複数行コメントは以下のような形です。
/*
コメントアウトする書き方
複数行の場合
*/はじまりを /* とし、終わりを */ で閉じることでその間の内容はコメントアウト扱いになります。
ただ、この複数コメントの場合使い方をルール化しないとややこしくなります。
例えば数行とかであればよいのですが長くなってくると1行コメントと違い頭に//がついていないので、これがコメントアウトされているかどうかが判断しにくいのと、コメントアウトをやめるときにはじまりと終わりを探すのが面倒です。
コメントアウトを使用するときはどういった時？
これらコメントアウトはどのような場面でしようすべきかをお伝えしたいと思います。
基本的に以下の3つになるかなと思います。
- コードの説明
- 後で確認したいときのTODOメモ
- プログラミング中の消さずに置いておきたいロジック
コードの説明
基本的に１がほとんどです。
このコードはどういったことしてますといった説明書きで使用することがほとんどです。
// 出かけるときの持ち物判定
if (weather === '雨') {
console.log('傘');
}上記みたいな感じです。
複数行コメントについては上記で記載してました通り、あまり長い行をコメントアウトすると分かりにくくなります。
だいたい関数の頭にどういう処理をしているのかを書く際に使用することが多いです。
/*
テスト用の関数です。
引数：文字列
*/
function test(param) {
console.log(param);
}
test('テスト');後で確認したいときのTODOメモ
続いてTODOメモになります。
そういったものかというとちょっと後でこの処理を見直したいとか、一旦この処理は暫定で入れているけどいつか消したいなど後で確認するのが分かりやすくするために使用することがあります。
ただ、１に比べるとそこまで多くないので自身のプログラミングしてる中で気になる点がある場合に以下のような形でマーク付けておくと、後でTODOで検索したときにその位置にたどり着きやすくなります。
// TODO 後で見直すプログラミング中の消さずに置いておきたいロジック
このコメントアウトは結構やったりします。
コーディングする上で、どういう処理がすっきりするか、または自分が思った通り動作しなくて案１案２案３みたいのがあった場合、案１試してみたけど後で利用できるかもしれないからちょっと残しておきたいとかで使います。
以下のような感じです。
// if (weather === '雨') {
// console.log('傘をもっていく');
// }
if (weather === '雨') {
console.log('傘とレインブーツがよい');
}上のif文がコメントアウトされていることで、処理としては動作しないが実装したコードを残しておくことができます。
基本的にどのプログラミングにもコメントアウトがある
今回はjavascriptでのコメントアウトの書き方でしたが、他のプログラミング言語にも同様にコメントアウトという考えが存在します。
違うプログラミング言語を学ぶ際にも必ず登場してくるかと思うので今のうちに理解しておくとよいでしょう。
最後に
コメントアウトの書き方、使う場面について書きました。
便利なのでよく使用するのですが、あまりコメントを書きすぎるとコードが読みにくくなるので書く場合は完結に書いて、不要なコメントは削除するほうが良いでしょう。
このあたりは携わるプロジェクトにコーディング規約というものがあればそれに従うようにすればいいので、最終的なコードはそのルールに従う形で精査しましょう。
途中経過の場合は好きにコメント入れていけばいいので、存分に使用するといいです。
ただ、最後リーダなりお客さんなりにお出しするときは不要コメントがないか確認するのを忘れず行いましょう。
コメント