プログラミングの命名で使える単語・使うべきでない単語を徹底調査
「プログラミングの関数名で参考になる単語が知りたい」
「ネーミングで気をつけなければいけないことは何だろうか」
と思うことはありませんか?
コードを書いているときに、関数や変数名を決めようとしても、いろいろな単語があって迷ってしまいますよね。
では、プログラミングの命名時に使える単語にはどのようなものがあるのでしょうか?
そこで今回は、
- プログラミングの命名で使うべきでない言葉
- プログラミングの命名で使いやすい単語
- ネーミング時に気を付けるべきこと
について詳しく解説します。
この記事を読めば、プログラミングの命名で、コーディングをしている手を止めることが少なくなります。
ぜひ最後まで読んでみてくださいね。
プログラミングの命名で使うべきでない5種類の言葉
プログラミングの命名で使うべきでない言葉をご紹介していきます。
変数名や関数名は、後から見たときのために、わかりにくいものは避けたほうが良いです。
- 属性やプロパティ名でよく使われている単語
- 意味が広すぎて主旨が伝わらない単語
- 意味なく長い名前となる単語
- 動作だけを表して結果がわかりにくい単語
- 状態がわかりにくい単語
それぞれ順にみていきます。
1.属性やプロパティ名でよく使われている単語
属性やプロパティ名で使われている単語は、使わないほうが良いでしょう。
なぜなら、既存の属性やプロパティと似ていると、間違ってしまう可能性があるから。
例えば、以下のようなものです。
- get
- set
- test
より具体的な、saveやenable、registerなどと置き換えることをおすすめします。
2.意味が広すぎて主旨が伝わらない単語
意味が広すぎる単語も使わないほうが良いでしょう。
後から見返したときに、何のための関数や変数かがわかりにくいからです。
- change:何を変えているのかわからない
- check:何を調べているかわからない
上記のような単語だとよくわからなくなるため、より具体的な単語に置き換えましょう。
3.意味なく長い名前となる単語
意味なく長くなってしまう単語も、避けておきたい使い方です。
なぜなら、長い単語だとコーディングの際に、タイピングが大変だから。
例えば、◯◯が英単語だとすると、以下のように続けると単語が長くなりがちです。
- ◯◯Class
- ◯◯Manager
- ◯◯Data
なくても意味がわかるなら、できるだけ短いほうが良いといえます。
4.動作だけを表して結果がわかりにくい単語
動作だけを表す単語も、やめておいた方が良いでしょう。
その理由は、結果がわかりにくいため、実際は何をおこなっているのかがわからないからです。
例として、比較の意味で、compare(比較する)を使いたいなら、より具体的なisBiggerやexistsなどが良いといえます。
5.状態がわかりにくい単語
見ただけで状態がわからない単語も、使うべきではありません。
なぜなら、プログラムはいつ見直すことになるかがわからないからです。
例えば、toggleなどを使うと、オンなのかオフなのかがわかりません。
その場合は、turn_on/turn_offなど、何をしているのかや状態がわかりやすいものを選んでください。
書いている間はわかっていても、時間が経ったあとでもわかりやすいものが良いでしょう。
プログラミングの読みやすいコードの書き方のコツ5つを解説!練習方法3選も紹介プログラミングの命名で使いやすい対の単語10選
プログラミングの命名で使いやすい対の単語をご紹介します。
対の単語を使い分けることで、後からでも、状態や何をしているかがわかりやすいからです。
ひとつずつ見ていきましょう。
1.first/last
データの順番を管理する単語として、first/lastがよく使われます。
使える場面は以下のとおり。
- 最初(first)や最後(last)のデータを取り出す
- データの登録日や最終更新日を管理する
first/lastは、具体的でわかりやすいので、よく使える単語として覚えておきましょう。
2.min/max
min/maxも、使いやすい対の単語です。
以下のような場面で使えます。
- データの最大値(max)や最小値(min)を取得
- 値を格納する変数
最大・最小のデータを管理したいときに使えます。
3.top/last
使える単語のペアとして、top/lastもあります。
topは先頭や上を意味し、lastは最後尾や一番下であることを意味します。
例えば、アンダーバーやその後に大文字で始まる単語を続けることで関数名や変数名にできるのです。
- top_button
- topSection
top/lastを使えば、位置を表すので、わかりやすいです。
4.start/stop
start/stopも、使いやすい対の単語ペアです。
以下のように使えます。
- start_calculation
- stopGame
何かを始めたり、止めたりするときに使える単語です。
5.add/remove
機能を追加・削除する単語として、add/removeが使えます。
addやremoveに続けて、足したいもの・消したいものを書くのです。
- add_number
- removeBackground
何がどうされるのかがとてもわかりやすい書き方を心がけてください。
6.up/down
上下に動かしたいときに使える単語として、up/downがあります。
- move_up
- moveDown
表示やものの位置を変化させたいときに使える単語です。
動作を表す単語として使えます。
7.upper/lower
文字サイズなどで使われるupper/lowerも使い勝手が良い対の単語です。
以下のように使えます。
- upper_case
- lowerCase
upper/lowerは、フォント変更をする機能などに使える単語です。
8.wide/narrow
wide/narrowは、幅を表す対の単語です。
画面サイズに応じた値を格納するときなどに使えます。
- wide_screen_width
- narrowSpaceHeight
幅に関する値を格納するときに使用してみましょう。
9.over/under
over/underは、何かの位置を上にしたり、もぐらせたりするときに使える単語です。
具体的には以下のように使えます。
- over_image
- underLayer
上に何かをかぶせたり、もぐらせたりする関数名として、使いましょう。
10.before/after
before/afterは、前後で区別をしたいときに使える単語です。
何かの処理より前や後にやらなければならないことがあれば、関数名や変数名に組み入れましょう。
- before_update
- afterUpload
処理をおこなう前後のデータを入れておく変数名や、実行すべき関数名として使います。
プログラミングの変数とは?3つのメリットや使い方を初心者にもわかりやすく解説ネーミング時に気を付けるべき単語7選
ここでは、ネーミング時に気を付けるべき単語をご紹介していきます。
意味が似ているので、使い方を間違えていることが多いからです。
- ログインを表す単語
- 認証を表す単語
- ジャンル・種類を表す単語
- カテゴリーを表す単語
- 終了を意味する単語
- 表示を表す単語
- 最新・更新を表す単語
それぞれ見ていきましょう。
1.ログインを表す単語
ログインを表す単語には気を付ける必要があります。
なぜなら、似たようなものがいくつもあるからです。
- login/logout:コンピューターやプログラムを利用可能するのがlogin、不可能にするのがlogout
- log on/log off:認証を受けて、コンピューターを使えるようにするのがlog on、使えないようにするのがlog off
- sing in/sign out:アカウントによる認証で、サービスやプログラムが利用できるのがsign in、できないのがsign out
ほとんど同じような意味でも使えますが、チーム内などではきちんとルールを決めておく必要があります。
2.認証を表す単語
認証を表す単語にも気をつけましょう。
似ていながらも、意味が微妙に異なるからです。
- authentication:2者間での認証
- certification:3者間での認証
certificationは、金融機関などの第三者が認証手続きをおこなう場合などに使われます。
違いを理解したうえで使用してください。
3.種類を表す単語
種類を表す単語も複数存在します。
それぞれの意味が異なる場合もあり、誤解を招かぬよう統一して使うようにするのがおすすめです。
- type:はっきりと分類できる種類
- class:階級などとも取れる種類
- sort:おおまかな種類や性質(イギリス)
- kind:おおまかな種類や性質(アメリカ)
後から見返しても、わかりやすいものを使う必要があります。
4.カテゴリーを表す単語
カテゴリーを表す単語も多いです。
多くの集合体をカテゴリーごとに分ける際に使います。
- category:区分に近い意味のカテゴリー
- genre:分野に近い意味のカテゴリー
- group:単なる集合体
どのようなカテゴリーで分けたいのかで、適切な単語と組み合わせましょう。
5.終了を意味する単語
終了を意味する単語も、いくつも存在します。
明確に使い分けられるほど、意味もそれぞれ異なります。
- stop:動いているものを止める
- end:始まったものが終わる
- complete:完成させる
- finish:始めたことを終わらせるという意図が見える
- finalize:最終決定をする・仕上げる
- terminate:打ち切りになる
何を終了させたいのかやどのような状態で終了させたいのかで、使うべき単語が異なってきます。
6.表示を表す単語
何かを表示したいときに使える単語も困惑しやすいです。
コーディングでも、何かを表示させることはよくあります。
- show:示すや表すなど、幅広い表示の意味で使える
- display:展示する
- exihibit:displayのフォーマルな言い方
何をどのように表示するのかで、使い分けましょう。
7.最新・更新を表す単語
最新・更新を表す単語もしっかりと使い分けてください。
なぜなら、微妙に意味が異なってくるからです。
- renew:契約の更新など、再び新しくするの意味
- update:ソフトウェアの更新など、新しく追加する意味
- upgrade:機能などの拡張など、大幅な追加という意味
間違った場面で、別の単語を使えば、意図しない意味で捉えられてしまいます。
大まかな意味を理解して使うようにしましょう。
命名時のスペルミスに気を付けるべき単語3選
スペルミスに気をつけなくてはならない単語をご紹介していきます。
コードが完璧だとしても、スペルミスが多いと、印象が悪くなってしまいます。
- 同じアルファベットが2つ続く
- lとrのどちらも存在する
- 発音が同じ
ひとつずつ解説します。
1.同じアルファベットがふたつ続く
同じアルファベットが連続で続く単語があります。
とくに原型ではひとつしかないので、間違えやすいです。
- putting
- getting
- setting
- programming
動詞の原型ではアルファベットがひとつでも、現在進行系でingが付くと、アルファベットがふたつ重なります。
ing系を書くときは、とくに気をつけましょう。
2.lとrのどちらも存在する
lとrのどちらでも、単語が存在する場合はスペルミスに気をつけましょう。
日本語では発音が同じなので、間違えやすいです。
- light/right
- collect/correct
- read/lead
それぞれの単語の意味も知っておくと間違えにくくなります。
3.発音が同じ
rとl以外にも、発音が同じものにも気をつけましょう。
意味を理解していないと、違いがわからなくなります。
- ad/add
- cash/cache
- be/bee
- sent/cent/scent
発音よりも、意味の違いに注目して使ってください。
プログラミングの命名に関する疑問
プログラミングの命名に関する疑問とその答えをご紹介します。
よくある質問には、多くのヒントが隠されているからです。
- 変数名や関数名は、なぜ命名規則に従うのか
- codic(ネーミングツール)とは
ひとつずつ見ていきましょう。
1.変数名や関数名は、なぜ命名規則に従うのか
変数名や関数名を命名規則に従い作ることは、一貫性を持たせるという意味でとても重要です。
なぜ一貫性を持たせるべきかの理由は、以下のとおりになります。
- チーム内での共有に役立つ
- 将来見返したときにわかりやすい
- 見た目が良い
- 名前から決まった情報が読み取れるようになる
- 名前の重複が避けられる
命名規則は、覚えるのが大変ですが、一度覚えたら利点も多いのです。
後々のトラブルや面倒を避けるためにも、命名規則に従い、一貫性を持たせるようにしましょう。
2.codic(ネーミングツール)とは
codicとは、日本語を翻訳し、変数や関数で使える文字列を返してくれるツールです。
- ネットがあればどこでも使える
- 無料で利用できる
- 日本語が自動で翻訳される
- 単語の間には自動でアンダーバーが入る
英語が苦手な方でもいちいち調べたりする必要がないため、人気のネーミングツールです。
もしネーミングに困ったら、ぜひ使ってみてください。
プログラミングの「関数」とは?3つのメリットやできること・使う手順を詳しく解説まとめ:プログラミングの命名は、できるだけ具体的に書こう
当記事では、プログラミングのネーミングで使うべきでない単語や使える単語について解説してきました。
- プログラミングで使うべきでない言葉は、誤解を招きやすい抽象的な単語
- プログラミングの命名では、具体性のあるわかりやすいものを選ぶ
- ネーミング時には、意味が似ているが微妙に異なる単語に気をつけよう
コーディングをしている方は誰もが、関数や変数の命名に時間をかけたいとは思っていないはず。
ただ適当に命名すると、後で困ってしまうこともあります。
最初は面倒でも、きちんと統一したルールを作り、いつ見ても内容が思い出せるよう、具体的な単語を選んで書いていきましょう。