プログラミング時の変数名を名付けるのに便利なサイト【codic】

ソフト

こんばんは、黒猫です。

今日は、プログラミング時に役に立つサイトの紹介をします。
プログラミングするときに変数名何にしようかな〜?どんな英語が適切かな〜?と悩む人もたくさんいるかと思います。
変数名を適切に決めないと後々になって非常に困ることもあるのでしっかり決めておきたいですよね。

サイト以外でもプラグインを導入すれば、エディタ内でcodicと同じように変換が使えるのでそちらについても紹介していきます。


codicって??

codicはプログラムを書くときに変数名決めを手助けしてくれるサイトです。

変数名で困ったときはこのサイトを参照して名前を決めています。
例えば、「黒猫」という単語を使用したいときに英語表記が思い浮かばないとしましょう。
そういう場合、サイト内で「黒猫」と打つと自動的に「black_cat」と変換してくれます。
使い勝手は英語翻訳を使ったときと似ていますね。

適切な変数名が浮かばないな….ってときにこれが使えて非常に便利です。

チームでこのサイトを使用することもできて、互いに共通の変数名を共有したいときに使えますね。

また変数名の表記の仕方は

  • PascalCase(単語の頭を大文字にする表記)
  • camelCase(先頭単語以外の頭を大文字にする表記)
  • snake_case(単語同士を_で繋ぐ表記)
  • SNAKE_CASE(大文字で単語同士を_で繋ぐ表記)
  • ハイフネーション(単語同士を-で繋ぐ表記)

の5種類あります。
自分にあった表記法にしてみるといいですね。

ただ、毎回サイトに行って変数名を決めて、またコードを書く…というのは面倒ですよね。
以下では、codicをVisual Studio Codeで使用する方法について紹介します。

プラグイン自体は画像の8種類のエディタで使用できるようですので、他のエディタを使用している人はGithubで確認してみてください。

プラグインのサイトはこちら


codicをVSCodeで使用する

プラグインの導入

まずはプラグインを導入していきます。
extension追加の画面で「codic」と入力すると出てくるのでインストールします。

インストールするだけではcodicの機能は使えないので設定していきます。

アクセストークンの取得

まず、この機能を使用するためにcodicAPIのアクセストークンを取得する必要があります。

codicのサイトでアカウントの作成を行います。
アカウント作成後に右上のメニューからAPIステータスを選択します。

APIステータス画面からアクセストークンをコピーすれば準備OKです。

VSCode内での設定変更

次にVSCodeの設定画面を開きます。Macでは「command + ,」で開くことができます。
設定画面の「Files:Associations」にある「settings.json」を開きます。

※ VSCode 1.27からGUIでの操作ができるようになったみたいです。このVer.以前の場合は
直接ファイルを編集してください。

開いて先ほど取得したアクセストークンを入力します。
入力する文字列は「”codic.ACCESS_TOKEN”: “取得したアクセストークン”」となります。

「”codic.case: “PascalCase”」は次の操作で入力可能になりますが、面倒な方は直接コードを書いてもらって構いません。

次に、変数名の表記の仕方について設定していきます。
Macでは「command + Shift + P」、Windowsでは「Ctrl + Shift + P」の入力でコマンドパレットを開きます。
コマンドパレットに「codic」と入力すると三種類のコマンドが表示されるのでその中から
「Select Which Case to Use Globaliy」を選択します。

そうすると、変数名の表記を選択することができるので、自分の好きな表記に変更します。

これで設定は終了となります。この操作が面倒な場合は、前述のjsonファイル内で自分の使用したい表記でコードを入力してください。

実際に使用する場合

使用する場合はコマンドパレットを開き、「codic」と入力すると「Translate Japanese Phrase」と出てくるので選択します。
選択後、英語に直したい日本語を入力していきます。
例えば、「黒猫」と入力してEnterを押した場合、始めにblackと出てきて、次にcatと出てきます。
英語に直したときに複数意味が取れる場合は他にも選択肢が出るのでその場に合わせた選択をします。

例:「取得する」と入力した場合の変換


使用するまではいちいち画面を切り替えて、翻訳してまた戻ってくるといった感じでコーディングしていましたが、
プラグインを使用して変数名の付ける時間が短縮できるようになりました。(ホットキーだけで完結するのが良い!)
また、同じ単語を引いたときに、同じ翻訳で返ってくるのでコード内でいろんな同じ意味の単語を使用しなくなりました。
是非、使用してみてください。

コメント

%d人のブロガーが「いいね」をつけました。
タイトルとURLをコピーしました