目次
JavaScriptとコメント
JavaScript含めてコードを書くときには基本的にコメントをつける。
この記事ではコメントの書き方をまとめる。
コメントの文法
一行のコメント
// ここにコメントを書く複数行のコメント
/* ここに
コメントを
書く
*/ コメントの書き方
基本的に一行のコメントを使う
//を使う。慣例でこうなっている。
スラッシュとコメントの間は半角スペース一つ空ける。
/* ... */は使わない。
コメントが長くなる場合
// 以下の関数は次の条件がある。
// 条件1
// 条件2/* ... */は使わない。
コードの目的を書く
コードの処理の内容を書くではなく、コードの目的や意図を書く。
また、関数名や変数名が目的を表している場合はコメントは不要。
ログの出力
ログを出す処理をしたときにどのような処理が起こるか、起こって欲しいかを書く
console.log(items); // ['book', 'paper', 'glass']長い場合は以下のように書く
console.log(items);
// ['banana', 'paper', 'glass', 'water', 'scissors', 'pen']以下のような書き方はNG
// Logs:: ['book', 'paper', 'glass']
console.log(items);まとめ
コードの可読性を高めるためにコメントを活用しよう。