こんにちは、Comeokaです。
みなさんでプログラミングをするとき 変数名のネーミングってどうしていますか？
- 日本人なんだから日本語で名づける
- 日本語はあれだからローマ字でつけていている
- 和英辞書や翻訳サイトでそれっぽいのをつける
- どっかのサイトコピペしたコードだからよくわからない
- 英語ぺらぺらだから意味も踏まえた最適なネーミングをしている
⑤ができる人は尊敬しますね～
ちなみにわたしは③だったのでGoogle先生にお世話になりつつ以前はネーミングをしていました。
正直なところ変数名がてきとうでもプログラムは動作はします、しかし格納する値の意味やニュアンスがわかるネーミングをつけることでコメント代わりにもなるので、後々修正をするときなどの効率に大きく影響していきます。
今回はそんなプログラムの変数名のネーミングに悩む方にぴったりのサービス、プログラマーのためのネーミング辞書「Codic」をご紹介したいと思います。
Codicとは
Codicは、変数名をつけたいニュアンスの日本語で入力するとその語句にあった英語を生成してくれるお手軽ネーミング辞書です。
これだけきくと、Googleの和英翻訳と変わらなくない？と思うかもしれません。
が、しかしCodicのキャッチコピーは「プログラマーのためのネーミングツール」です！！
例えば、「最終行を取得する」という日本語をGoogle翻訳した場合とCodicの場合ではこのような結果になります
通常の翻訳サイトでは文章で翻訳されてしまうところを、Codicではニュアンスをくみ取りいい感じの変数名として生成をしてくれます。
また日本語で単語を入力したとしても、Codicはプラグラムでよく使われている英単語が数多く登録されているため、プログラム向けのいい感じのネーミングが生成されます。
ほかにも便利な機能がいくつもありますので見ていきましょう！
Codicへログインをしよう
Codicはアカウント登録をせずとも利用することができます。
しかし、無料のアカウントを作成してログインをすると機能制限がなくなります。
また、「Twitter・Facebook・GitHub」のいずれかのアカウントでログインをすることも可能です。
初めてログインをするとまず「プロジェクトの作成」画面が表示されます。
無料プランでは最大３つのプロジェクトを作成することが可能です。
プロジェクトは後から名前を変更したり削除することも可能なので難しく考えずはじめは適当に作ってしまいましょう！
Codicのつかいかた
日本語→英語でのネーミング
基本の使い方はとってもシンプルです。
左側のスペースへ日本語で入力すると、右側のスペースにいい感じのネーミングがすぐに生成されます。
また、改行をして日本語を入力すると複数のネーミングを一一度に行うこともできちゃいます。
英単語を変換する
動画の流れを文章で説明すると
「年を取得する」と日本語で入力すると、はじめは結果「GetYear」とネーミングしてくれました。
「年」を「年度（Year)」と認識されましたが、実は「年齢（Age）」の意味合いで入力していたので「Year」を「Age」へと変更し「GetAge」へました。
また、動画の最後に変換を適用させていますが、そうすることで次回より「年を取得する」と入力したときに「GetAge」が最初に表示されるようになり、このようにCodicでは辞書を自分仕様にすることができます。
英単語の意味を調べる
英単語をクリックして変換リストの候補を表示すると小さな矢印が単語の右横に表示されることがあります。
この矢印をクリックすると単語の意味を調べることができます。
候補に表示される単語も微妙にニュアンスが異なるので、コードの処理にあった単語を選ぶことができます。
単語を並び替えする
複数の英単語からなるネーミングをした場合、英単語の並び替えが行えちゃいます。
単語の並び替えを行うときは Ctrl + マウスドラッグ で単語を移動できます。
英単語を複数形にする
Codicでは単語の末尾に「s」を付け加えるだけで簡単に複数形にすることができます。
また「人」という単語のように単数形では「person」ですが、複数形では「people」というように変則的なものにもすべてではないですが対応しています。
真偽値でネーミングする
真偽値は真と偽の英語であるTrueとFalseを返すような場合に用います。
真偽値をつけたい場合は「～か」のように日本語で入力するといい感じのネーミングをしてくれます。
| 日本語 | ネーミング |
|---|---|
| 有効かどうか | isEnabled |
| 終わりか | isLast |
| 空かどうか | isEmpty |
ケース変換
ネーミングを生成する表示形式を変更することができます。
プログラミングする言語によって特色があるので、勉強しているプログラミング言語によってケースを変換して使用しましょう！
| ケース | 適用 |
|---|---|
| PascalCase | 単語の頭文字を大文字 |
| camelCase | 2つ目以降の単語の頭文字を大文字 |
| snake_case | 全小文字の単語を「 _ （アンダーバー） 」 で接続 |
| SNAKE_CASE | 全大文字の単語を「 _ （アンダーバー） 」 で接続 |
| ハイフネーション | 全小文字の単語を「 – （ハイフン） 」 で接続 |
| 変換なし | 全小文字の単語を半角スペースで接続 |
さいごに
いかがだったでしょうか？
プログラミングをする中で変数のネーミングに悩む時間を多く割かれている人にとって、Codicを利用することで少なからず時間短縮につながるのではないでしょうか？
英語が苦手で日本語やローマ字でネーミングをしているのならば、翻訳サイトなどよりはかなり便利なのでぜひ一度試してみてください！
現在は無料プランのみですが、今後のアップデートではCSVインポートや単語の編集などの機能が利用できる有料プランも公開されるようですので、興味のある方はTwitterやFacebookで更新をチェックしてみてくださいね。
