朝会発表テーマ

変数・関数のネーミングツール「codic」

1. 経緯

コーディング作業を行っている時、変数や関数の名づけ方に悩むことが多かった。変数名や関数名は英語で名づけていたが、自分で思い浮かばない場合は翻訳サイトを頼っている。しかし、時折長い文章で翻訳されてしまい、困ってしまうことがあった。

そんな時、SNSで「codic」というネーミングツールを知ったことが今回の発表の経緯である。

2. codicとは

キャッチコピーは「プログラマーのためのネーミング辞書」である。

日本語を入力することで、その語句にあった英語を生成してくれるツールである。

通常の翻訳サイトとは違い、プログラム向けの英語を生成してくれる。

例:最終行を取得する

  Google翻訳 → Get the last line

  codic → getLastRow

3. 使い方

左側の空欄に変換したい単語を日本語で入力すると、右側に変換結果が表示される。

改行して別の単語を入力することで、複数の単語を変換することもできる。

また、入力の仕方を変えることで、用途に合わせた変換を行ってくれる。

① 変数名を生成する

上記の通り、変換したい単語を入力すると生成される。

② 関数名を生成する

「〇〇を△△する」のように、最後に動詞を持ってくることで関数名が生成される。

③ 真偽値を扱う変数名、もしくは関数名を生成する

文の最後に「~か」、もしくは「~かどうか」と入力することで生成される。

④ 英単語の意味を調べる

生成された英単語をクリックすると、同様の意味を持つ単語がリストに表示される。そのため、このリストからコードの処理に合った単語を探すことができる。

また、リストに表示されている矢印をクリックすることで、

英単語の意味を知ることもできる。

⑤ 命名規則の設定

左上の「Aa」をクリックすることで、表示形式を変更することができる。

PascalCase単語の頭文字を大文字 例) IsEmpty
camelCase2つ目以降の単語の頭文字を大文字 例) isEmpty
snake_case全小文字の単語を「 _ 」で接続 例) is_empty
SNAKE_CASE全大文字の単語を「 _ 」で接続 例) IS_EMPTY
ハイフネーション全小文字の単語を「 – 」で接続 例) is-empty
変換なし全小文字の単語を半角スペースで接続 例) is empty

4. まとめ

・変数名や関数名を考えることが苦手な人には便利なツールだと思った。

 他の翻訳サイトと併せて利用していきたい。

・過去に作成したソースコードを見直し、変数名や関数名が分かりやすい名前になっているか確認するようにしたいと思った。

参考サイト

codic - プログラマーのためのネーミング辞書
codicは、プログラマーのためのネーミング辞書です。新しいcodicでは、翻訳エンジンを搭載しネーミングをジェネレートできるようになりました。
変数のネーミングに悩む方にお勧め!プログラマーのためのネーミング辞書「codic」
プログラミングをするときに変数名にいい感じのネーミングをつけようと時間をかけていませんか?手軽にプログラミングのためのネーミング辞書「Codic」を使えば頭を抱える時間をプログラミングに使えます。翻訳サイトや和英辞書を使っていちいち調べてい...
【codic】プログラマ必見!もう変数名や関数名に困らない!プログラマのためのネーミングツールを紹介 - プログラミング雑記
変数や関数の名づけ方 プログラミングをしているとき、結構困るのが変数や関数の名づけ方。 皆さんはどのように名前を付けていますか? 英語はぺらぺら!意味やニュアンスまでちゃんと対応した英語がすぐに浮かぶ! 英語は苦手...和英辞典をひいてそれ...
codicでやりたかった事 - codic ブログ

コメント