コメントの使い方と意味のある命名規則
- はじめに 今回は、コメントの使い方と意味のある命名規則について学びましょう。コードの読みやすさと保守性を向上させるために、コメントと命名規則がとても重要です。それでは、二人の説明を見ていきましょう。
コメントってなに？
コードにメモを残すためのものだよね？
そうなの！コメントは、コードの説明や目的を書いて、他の人や自分が後で理解しやすくするためのものよ！
JavaScriptでは、一行コメントには
//
を使って、複数行コメントには
/*
と
*/
を使うの。例えば、こんな感じ！
// 一行コメント
/*
複数行コメント
ここに説明を書く
*/
なるほど、コメントはコードの説明や目的を書くために使うんだね！
そうなの！そして、意味のある命名規則っていうのは、変数や関数の名前をわかりやすくすることなんだよね。
短すぎず長すぎず、一目でわかる名前がいいわ。例えば、こんな感じ！
// 悪い例
let a = 3;
let fn = function() {};
// 良い例
let age = 3;
let greet = function() {};
わかった！意味のある命名規則は、変数や関数の名前をわかりやすくすることなんだね！
そうなの！コメントと意味のある命名規則を使うことで、コードが読みやすくて保守しやすくなるのよ！
- おわりに コメントの使い方と意味のある命名規則によって、コードの読みやすさと保守性が向上します。コメントを適切に使って、変数や関数にわかりやすい名前をつけることを心がけましょう！😀