命名に悩んだ時には、、、
はじめまして、ソリューションSecの北島です。
みなさんはプログラミングをする中で、変数名やメソッド名に困った経験はありませんか?
恥ずかしながら、私は英単語がパッと出てこないのでよくGoogle先生に助けてもらいます。。
また、Google翻訳等で検索した単語でも、なんかしっくりこないな〜と感じる事はないでしょうか?
今回は変数名の命名を助けてくれる面白いツールを見つけたのでご紹介します。
Codic
Codicというツールです。ブラウザ上で利用可能です。(VSCodeの拡張もあるようです)
使い方はシンプルで、日本語を入力するだけでそれに適した変数名を返してくれます。
試しに、「有効か」というワードで翻訳した場合どうなるのか、他の翻訳ツールと比較して見てみましょう。
このように「有効」という単語ではなく、「有効か」という文章としての入力でもCodicでは無駄を省いた変数名っぽくしてくれます。
is_validという変数名がしっくりこない!使いたくない!と思ったら、文字をクリックすると類似の単語をリストアップしてくれます。
類義語を何度も検索しなくても良いので便利ですね。
また、命名規則はスネークケースだけでなくキャメルケース、パスカルケースなどの選択も可能です。
基本的にはログインなしでも使用できますが、ログインすると辞書をカスタマイズすることも可能です。
さいごに
特にプログラミング初学者の方は、命名の仕方について悩むことが多いと思いますのでぜひ活用してみてください。
しかし、翻訳で出てきた変数名をそのまま使用するのではなく、
・より世間に浸透していてわかりやすい単語はないか
・ソースコード内に類似の変数名がないか
・長い場合、省略することはできないか(flag→flg, image→imgなど)
この辺りの点は考慮した上で、Codicは参考程度に使用するのが良いかと思います。
以上、Codicの紹介でした!