S-Collection株式会社 システムについて

S-Collection株式会社のシステムサポート事業

【プログラミング】変数とメソッドの命名法を紹介!適切な名前は仲間への思いやり!!

可読性に直結!変数とメソッドの命名方法!

プログラミングをしていて、変数とメソッドの名前をどうつけるか悩む方も多いのではないでしょうか。
プログラミングの入門書では「a」や「i」などのアルファベット1文字で名前を付けている場合をよく見かけます。

今回は、プログラミングで悩むことが多い変数とメソッドの命名方法について紹介します。
変数名とメソッド名を適切につけることができれば、コードの可読性も高まり、とても重要性が高いと思われます。

 

1.代表的な2つの変数とメソッドの命名方法!

まず、変数とメソッド名の命名方法にどんなものがあるかを紹介します。
代表的な記法としてはキャメル記法とスネーク記法があります。

キャメル記法

キャメル記法は各単語の先頭文字を大文字にする記法です。
キャメル記法とそうでないものを例に出して比較してみましょう。

例①:username
例②:userName
例③:UserName

例①はキャメル記法を使用せずに書いたものです。
例②③はキャメル記法を用いて命名した変数名です。

キャメル記法のなかでも、例②のように2単語目の先頭文字から大文字で表現する記法をローワーキャメルケース、例③のように1単語目の先頭文字から大文字で表現するアッパーキャメルケース(パスカルケースとも)と呼ばれています。

キャメル記法のメリットは単語と単語の間に区切り文字がないので、名前を短くしやすいことです。
デメリットは区切り文字がない分、単語と単語の区切りがわかりにくいことが挙げられます。

スネーク記法

次にスネーク記法を紹介します。
スネーク記法とは、単語と単語の間に"_" (アンダースコア)を挟む記法です。
こちらも例を見ながら紹介します。

例④:user_name
例④のようなスネーク記法のメリットは、アンダースコアで区切っているので単語と単語の区切りがわかりやすいことです。
デメリットは、アンダースコアなどの区切り文字が入るため、名前が長くなりやすいことです。

ここでは、代表的な記法であるキャメル記法とスネーク記法を紹介しました。
コードを書くときはどんな記法を採用してもよいですが、2つの記法を混ぜないように、ひとつの記法に統一することが重要です。

 

2.ネーミング辞書「codic」でネーミングが苦手な人でも安心!

ここまで命名方法や、適切な名前による可読性向上のメリットについて紹介しました。
しかし、適切な名前をつけることはむずかしいと感じている方も多いのではないでしょうか。
そんな方は「codic」というツールを使ってみてはいかがでしょうか。
https://codic.jp/engine

このサービスでは、変数やメソッドとして宣言したい日本語を入力すると、自動でその候補を表示してくれます。
単なる翻訳サイトというわけではなく、IDE(Integrated Development Environment、統合開発環境)への対応、キャメル記法やスネーク記法などの命名方法選択、個人辞書登録、チームへの辞書展開などさまざまな機能があります。
こういったツールのサービスを使いコードの品質を高めてもよいでしょう。

プログラムの開発はチームで行うことがほとんどです。
そのため、可読性が高いコードを書くことはとても重要です。
可読性が上がると保守性も高まります。

自分が作成したプログラムを自分以外の人が修正することになったときに、意味が推測しやすく、適切な名前の付いた可読性が高いコードであれば修正のしやすさも向上します。
可読性高いコードであるだけで開発時間短縮につながりますし、コードの再利用もしやすくなります。
つまり、コードの品質を上げることは仲間への思いやりにもなります。

S-Collection株式会社では要望に合わせた最適なシステム構築をすることで、企業様へ貢献し続けていきます。