JavaScriptでコメントを書く方法と、コメントアウトについて書いています。
JavaScriptのコメントとは？
コメントは、スクリプトに処理の内容などの説明を書いておけるものです。
ソースコードの内容に説明を入れることにより、複雑な処理の箇所も理解しやすくなります。
下記は簡単なコードですが、このようにソースコードの任意の位置にコメントを入れることができます。
(スラッシュが頭に２つ書いている「// Helloを10回出力する」がコメントです）
// Helloを10回出力する
for (const i = 0; i < 10; i++) {
console.log()
}
関数コメントとは？
関数コメントは関数の処理内容をコメントとして、作成した関数の上に書いておくものです。
下記のように関数の上の方に書いてあるコメントが、関数コメントです。
複数行コメントの書き方で書いています。
関数コメントには関数の解説と、渡すパラメータやリターン値を書きます。
コメントを見るだけで、関数の動作がわかるようにしておきます。
/**
* 2つの値を足して、結果を返す.
* @param {number} val1 加算値1
* @param {number} val2 加算値2
* @returns {number} 結果
*/
function addValue (val1, val2) {
return val1 + val2
}
上記の関数コメントはJSDocの記載方法で書きました。
コメントを書くには？
JavaScriptでコメントを書く方法です。
前項で簡単に説明しましたが、書き方についてだけ確認していきます。
1行コメント
1行でコメントする場合は、下記のように記載します。
// コメント
スラッシュ(//)をふたつ書くと、その後はコメントになります。
コメント行はスクリプトの実行時に無視されます。
行の先頭から書くのではなく、下記のように途中からコメントを入れることも可能です。
let count = 0 // カウントするための値
複数行コメント
複数行をコメントする場合は、下記のように記載します。
/*--
複数行のコメント
--*/
スラッシュ・アスタリスク「/*」から始まって、「*/」アスタリクス・スラッシュまでがコメントになります。
途中で改行することも可能ですが、下記のように1行で書くこともできます。
let message = '' /* メッセージ用変数 */
コメントアウトとは？
コメントアウトはソースコードをコメント化して、処理が実行されないようにしておくことです。
// 下記がコメントアウト
// for (let i = 0; i < 9; i++) {
// console.log(`hello${i}`)
// }
このようにしておくことで、処理を残したまま実行させないようにしておくことが可能です。
ですが、Gitなどを使用して履歴管理している場合には、消したとしても一度コミットされていれば履歴に残っているので、コード消してしまっても問題ないと思います。
今後、直近ですぐに使う予定があるソースコードなどはコメントアウトしておいて良いかもしれません。
コメントアウトが増えるとコードがわかりにくくなるため、なるべく控えた方が良いかと思います。
どんなコードをコメントしておくと良いのか？
複雑でパッと見ただけではわかりにくい処理や、意味が伝わりにくいようなコードはコメントを入れておくと良いです。
自分で書いたコードでも何ヶ月も経つとわからなくなることがあるので、適宜コメントを入れておくことは結構大切だと思います。
基本的にはコメントを入れなくても、他の人もコードを読むだけでわかりやすいソースコードをこころがけて書くといいです。
変数名や関数名から処理が伝わるように書いて、それでもパッと見た感じでわかりにくかったり、仕様が複雑な箇所には適宜追加していくと良いかと思います。
コメント