プログラムを書くときに、役割や機能に応じて、適切な変数名やクラス名、関数名をつけることは、とても大切です。
プログラミング経験者であれば、適切な命名の重要性の高さは、分かってもらえるのではないでしょうか。
しかし、一言で「適切な名前をつける」と言っても、意外とすぐに決められず、難しいですよね。
そこで、今回は私が変数などの名前を考える時に使用している、「Codic」というサイトを紹介します。
このサイトを利用すると、変数名やクラス名に悩むという時間を削減することができます。
今回の重要ポイント
Codic を使い、分かりやすい適切な名前をつけることには、次の2点のメリットがあります。
- 適切な名前をつけられるようになることで、読みやすく保守性に優れたコードになる
- Codic を利用することで、変数名に悩む時間を削減できる
読みやすいコードを書くことは、非常に重要です！
まず、開発をする自分自身の、ケアレスミスを減らすことにつながります。
また、レビューを受ける時に、レビュワーの負担も減らせます。
さらに、数週間後にバグ修正を行なう時の負担も減らすことができます。
反対に、意味が適切でない名前が多用されているコードは、開発時、レビュー時、開発後の修正時にまで悪影響を及ぼすと言えます。
解決したい課題
変数の目的、中身が分かりやすい名前をつけることの重要性は、プログラミングをしたことがある人であれば、共感してもらえると思います。
しかし、コードの行数が増え、変数が多くなると、自分の語彙力・英語力では、変数名をつける事が難しくなっていきます。
私は、コードの行数が増えてくると、変数名を考えるのに、少し時間がかかってしまいます。
課題の原因
課題の原因として、ズバリ、英語で命名するからだと、考えています。
例えば、変数の役割を日本語で説明することは、簡単にできます。
しかし、英語で説明するとなると、難易度が跳ね上がります。
日本語の語彙力より、英語の語彙力が低いため、似たような変数名が増えたり、適切な名前を付けられなくなるのではないでしょうか？
課題の解決方法
Codic というサイトを使います。
Codic は、ブラウザ上で使えるプログラミングの命名に特化した和英辞典のようなものだと思っていただければ、間違いないでしょう。
Codic では、日本語で入力した変数の説明を、適切な英語の変数名に置き換えて、提案してくれます。
その提案を受けて、そのまま使うのも良し。
開発プロジェクトのルールに合わせて、アレンジして使うのも良しです。
Codic は無料で使用することもできます。
CSVインポート機能等が使える有料版も、準備中のようですが、コーディングの合間に利用する分には、現状の機能で十分だと思います。
Codic の使い方
Codic は、サイトにアクセスして、画面の左側の入力する部分に、変数やクラスの説明を入力するだけで、英語にしてくれます。
とはいえ、メソッド名を作る時や、Boolを返すプロパティにしたい時などは、ちょっとしたルールがあるので、ご紹介します。
メソッド名を作る場合
動詞で終わる形で入力する
何か、ファイルを作成するメソッドの場合は、”ファイルを作成する”とします。
※画像は、実際の画面を拡大したものを張り付けています。
Boolを返す場合
～か(どうか）の形で入力する
Bool、つまりTrue または False を返す場合は、”有効か”や”有効かどうか”の形で入力します。
※画像は、実際の画面を拡大したものを張り付けています。
複数形にする場合
名詞の末尾にsを付けると複数形に変換される
先程の、ファイルを作成するメソッドを、複数形にしたい場合は、”ファイルsを作成する”というように、ファイルの後にsをつけます。
Codic を上手く使って、命名にかかる時間を減らして、読みやすいコードを目指しましょう！！
