命名規則(Naming Convention)
📝 3つの命名スタイル
🐫
camelCase
キャメルケース
🐍
snake_case
スネークケース
🍢
kebab-case
ケバブケース
プログラミングでは、ファイルやデータ(変数)など、あらゆるものに「名前」を付けます。
この名前の付け方には、チームで開発をスムーズに進めるための、いくつかの**「書き方のスタイル(お作法)」**が存在します。ここでは、代表的な3つのスタイルと、この課題でどのスタイルを使うのかを学びましょう。
1. キャメルケース(Camel Case)🐫
書き方
最初の単語は小文字で始め、それ以降の単語の先頭を大文字でつなげる。
見た目: 小文字で始まり、途中が大文字で**ラクダのこぶ(Camel)**のように見えることから名付けられました。
userName
calculateTotalPrice
loginButton
2. スネークケース(Snake Case)🐍
書き方
すべての単語を小文字にし、単語の間をアンダースコア
_ でつなげる。見た目: 単語が**ヘビ(Snake)**のように長くつながって見えることから名付けられました。
user_name
calculate_total_price
login_button
3. ケバブケース(Kebab Case)🍢
書き方
すべての単語を小文字にし、単語の間をハイフン
- でつなげる。見た目: 単語が串刺しの**ケバブ(Kebab)**のように見えることから名付けられました。
user-name
calculate-total-price
login-button
なぜルールを守るのが大切なのか?
全員が同じルールで名前を付けることで、コードがどこにあって何をしているのかが一目で分かりやすくなります。これにより、他の人が書いたコードを読み解く時間が短縮され、チーム全体の作業効率が格段にアップします。
💡 実際の現場に参加したときは...
まずそのチームの「書き方のルール」に合わせることが、とても大切です。これは、変数名だけでなく、コメントの書き方など、様々なことに当てはまります。
ルールを知る一番良い方法
チームのメンバーに**「コーディング規約はありますか?」**と、まず質問してみることです。
もし明確な規約がない場合でも、すでにある他のコードを読んで、「ここでは、こういう風に書くのがお作法なんだな」と、周りのスタイルから学び、それに合わせていきましょう。
この課題でのルール
ファイル名は「ケバブケース」
コードの中は「キャメルケース」
コードの中は「キャメルケース」
まずは、このルールをしっかり守ることから始めてみましょう!
自動テストでの使い方
これらのスタイルは、どれが優れているというわけではなく、「どこで何を使うか」という慣習やルールによって使い分けられます。
この自動テスト課題は TypeScript で作成されているため、以下のルールで統一します。最終課題ではこちらを意識してテストシナリオの作成をお願いいたします。
| 使う場面 | スタイル | 例 |
|---|---|---|
| 変数名など、コードの中で使うデータ名 | キャメルケース | let userName = "山田太郎" |
| ファイル名 | ケバブケース | login-test.spec.ts |
🐫
コードの中
let userName = "Taro"
🍢
ファイル名
login-test.spec.ts