変数や関数の命名に自信がないときに使用するcodic。
実はVSCodeにプラグインが存在するらしい、というわけで入れてみました。
頼りきりになるのは良くないですが、なにか良い単語はないかと相談する相手にはちょうど良いと思います。
記事のターゲット
1、codicのプラグインをVSCodeに入れたい人
2、変数や関数の命名に苦戦している人
codicとは?
ちなみにcodicを使ったことがない人向けに紹介すると、入力した日本語に応じて良い感じの命名案を表示してくれます。
設定で、スネークケースやキャメルケースなども変更できる。
codicのサイトにアクセスして「使ってみる」をクリックし、アカウント登録をすると、すぐに使用できるようになります。
codicのプラグインの入れ方
それでは、codicのプラグインを入れてみましょう。
事前にアカウント登録をして、ログインしておきましょう。
codicのサイトにアクセスして「使ってみる」をクリックすると、画面左側にAPI(グラフのアイコン)①が表示されるのでクリックします。
ログインしている状態であれば、アクセストークン②が表示されるので、コピーしておきましょう。
次に、VSCodeを開いて、プラグインタブ①を開いて、検索欄②に「codic」と入力する。
codicのプラグインが表示されるので、インストール③をクリックする。
インストールが完了したら、プラグインの設定をしましょう。
Macなら、コマンドキーとカンマキーを押して設定タブ①を開く。
Windowsなら、コントロールキーとカンマキーを押して設定タブ①を開く。
設定タブの検索欄②に「codic」と入力すると、codicのアクセストークを入力できる箇所③があるので、コピーしたアクセストークンを貼り付ける。
これで設定は完了です。
codicのプラグインの使い方
それでは、codicのプラグインを使ってみましょう。
Macなら、コマンド+Shift+pキーを押してコマンドパレットを開いたら、「codic」と入力しましょう。
Windowsなら、コントロール+Shift+pキーを押してコマンドパレットを開いたら、「codic」と入力しましょう。
コマンドパレットに候補が複数表示されると思いますが、
「codic: Translate Japanese Phrase」を選択しましょう。
コマンドパレットが「日本語を入力しろ」と言ってくるので、日本語を入力してEnterキーを入力しましょう。
そうすると、(入力した日本語によるが)命名候補が1単語ずつ表示されるので、採用したい単語をクリックしていきましょう。
次々に候補が表示されるので、どんどん採用したい単語をクリックしていきます。
命名の候補の選択作業が終了すると、カーソルが置いてあった場所に命名した変数名(関数名)が表示されます。
以上です。
命名にはパターンのようなものが存在するので、経験がものをいう部分もあると思いますが、書籍などを読んでおけば事前に知っておくこともできるので、おすすめです。
命名に関する書籍や、読みやすいコードを説明している書籍はたくさんありますし、QiitaやZennにもたくさん記事があると思いますので、調べてみてください。
おすすめは、有名な書籍ですが「リーダブルコード」です。