プログラミングの変数・関数のネーミングに悩んだときは【codic】で解決!

プログラミングでわかりやすい変数名や関数名を付けることはとても重要ですよね。

わかりやすいメソッド名はコメント代わりにもなります。特にチームで開発しているなら尚更、「その関数や変数が何をするものなのか」をちゃんと説明している名前を付けることが求められます。

それだけに、変数名や関数名の付け方がわからない!という方は多いと思います。

私もメソッド名を考えるのが苦手で、いちいち英単語辞書を引いて合うような単語を探したり、Google翻訳を使ってみたりしていたのですが、めちゃくちゃ面倒です。

今回は、そんな変数名や関数名の付け方に悩むエンジニアにオススメのネーミング生成サービス「codicをご紹介します!

codicとは?

codicは、プログラミングの関数や変数のネーミングを生成してくれるとても便利なWebサービスです!

付けたい変数名を日本語で入力すると、
同時にその日本語に合ったネーミングを生成してくれます。

それだけではGoogle翻訳と変わらないように思えますが、このcodicの特徴は「プログラマー向けのツール」であるところ。

Google翻訳では文章のように訳されてしまう日本語でも、codicの場合はプログラミングの変数や関数に合うように訳してくれるんです。

また、自動生成してくれるだけではなく、生成された英単語の一部を変更したり、そのまま英単語辞書が見れたりといろいろと便利な機能があります。

codicの使い方

それではcodicの使い方や便利な機能を見ていきましょう!

1. 基本的な機能

まずは日本語から英語の変数名を生成してくれる機能です。

左側のエディタに、動詞で終わる形で日本語で入力すると、左側に自動でメソッド名を生成してくれます。

また、真偽値(Boolean)を返すメソッドやプロパティ名を付けたい場合は、「有効か」のように「〜か(どうか)」の形で入力します。

ほかにも

  • 「達成されたか」→「is_achieved」
  • 「初期化が終わったか」→「has_finished_initialization」

のように生成されました。

2. 単語を複数形にする

複数形のメソッド名を生成したい場合は、名詞の末尾に「s」を付けます。

ほかにも

  • 「本sは登録されたか」→「is_books_registered」
  • 「カテゴリーsを取得する」→「get_categories」

のように生成されました!

3. 生成された単語を変更する

自動生成された変数名の単語を変更することもできます。

例えば「辞書を取得する」と入力した場合、「get_dictionary」と表示されました。しかし、APIやネット上のページにアクセスして値を取得するような場合は「get」よりも「fetch」の方がわかりやすいですよね。

このように生成された単語を変更したい場合は、その変更したい単語をクリックします。

そうすると類語が表示され、適切な英単語を選ぶことができるようになります。

変数名はわかりやすさがとても大事なので、こういうように細かいニュアンスまで伝えられるように調整できるのはとても便利ですよね!

ネーミングをカスタマイズするためには、無料の会員登録が必要です。

4. 英単語の意味を調べる

生成された変数名に使われている英単語の意味を調べることもできます。

調べたい英単語をクリックし、出てきたボックスの右側の「>」ボタンを押すと、右のサイドバーに英単語の意味が表示されます。

生成された変数が、自分の意図したニュアンス通りになっているか確認することができて便利です。

5. ケースの変換(キャメルケース、スネークケースなど)

今回の例の画像では、アンダーバーで英単語をつなぐスネークケース記法を設定していますが、上部のメニューからケース変換を行うこともできます。

変換できるケースは

  • PascalCase:アッパーキャメルケース
  • camelCase:ローワーキャメルケース
  • snake_case:小文字のスネークケース
  • SNAKE_CASE:大文字のスネークケース
  • ハイフネーション:ハイフン「-」で単語をつなぐ
  • 変換なし:単語の間が半角スペースで表示される

の6つです。

言語やチーム内の書き方などによって使い分けることができて良いですね!

まとめ

codicは、変数名や関数名に悩むことの多いエンジニアにとって、とても便利なWebサービスです。

私はメソッド名を付けるのが苦手で、メソッド名を考えるのに結構な時間をかけてしまっていました。

それなので、プログラミングに特化したネーミングを生成してくれるcodicを知ってからは、変数名をサクッと付けることができるようになってとても助かっています。

私と同じように変数名の付け方に苦手意識がある方にオススメのcodic、ぜひ使ってみてはいかがでしょうか!