phoenix-power固有名詞を付けることで、ネーミングが楽になります。後、いろいろ良いです。

ネーミングの問題

基本的な問題

プラグインなどを作った場合、最近、GitHubに置くことにしました。

そこで、プログラムを書く際に、重要というか、面倒なのがネーミングです。プログラム本体のネーミングもそうですが、変数、関数のネーミングも非常に面倒なわけです。

更に、考えなければならないことも多く、例えば、グローバル変数を使う場合には、他のプログラムとのマッチング、衝突を避けなければなりません。したがって、一般的な名前、つまり、directorypathargslineなどそういったものを使用するのは控えるのが通常です。

ここで、上記のような場面では、通常、名前を長くするか、分かりにくくするかの方法が考えられます。

しかし、名前を長くするのも多くのキーワードを用いなければならず、面倒ですし、分かりにくくすると、後々自分が困る(時間を取られる)ことになります。

基本的な問題の解決策

初期の考え方

したがって、私は、自分が使う固有名詞を一つ用意しておいて、それを使うことにしました。

具体的には、airという固有名詞をプログラム本体、変数、関数に特に考えなしに適応していくという方法です。

ここで、固有名詞をつけようかどうしようかと迷うのも本末転倒ですし、基本的には付けることにしています。

この辺り、最初はすごく適当ですが、そのうち、自分ルールが出来上がってきて、良い方向に修正されていくだろうと思います。たぶん…。

具体的なネーミング

具体的なネーミングについては、プログラミ本体やディレクトリには、特に区切りを付けることなく、「air」を付けています。

その理由は、区切りが多くなってしまうことでメリハリが無くなってしまうことを避けるためです。

例えば、vimpreviewプラグインを書いた場合は、airpreview.vimのようになります。

これがzshだった場合は、airpreview.zshですね。

ここで、一般的なネーミングのメリット・デメリットを示します。

名前 メリット デメリット
preview シンプル 分かりにくいし、検索の問題も多そう
preview.vim 分かりやすく一般的 色々考えなければならないし、検索する必要性も出てくる
preview-air.vim 分かりやすく、固有名詞のメリットも取り込んでいる。 検索では微妙な効果があるかもしれないが、シンプルではない。
previewair.vim シンプル。固有名詞のメリットは取り込んでる 分かりにくい
vim-preview 分かりやすく一般的 色々考えなければならないし、検索する必要性も出てくる
vim-preview-air 検索ヒットが考えられるし、固有名詞のメリットを取り込んでいる 視覚的に複雑さがあり、ダサさがある
airpreview.vim 区切りは拡張子だけなので、視覚的にシンプルであり、シェル補完しやすい。区切り文字によって生じる問題を可能な限り回避できる。 分かりにくい。ダサい。何のプラグインか検討がつきにくい。検索からの使用者はゼロが予想される。
air-preview.vim 分かりやい。見ようによってはカッコイイ。拡張子から検索しやすさがある。 名前が長い印象を与える。
air-preview-vim 分かりやすい。 ダサい。個人的には受け付けない。

個人的な候補としては、airpreview.vimair-preview.vimpreview-air.vimが考えられました。

しかし、airで始まらないネーミングは、一般的な検索では有効であるものの、個人的な検索では、自作ツールが検索しにくいという問題があります。したがって、却下されました。

最終候補としては、airpreview.vimair-preview.vimが残ります。

この点、個人的には、シンプルさを優先し、前者であるairpreview.vimに決めました。

分かりやすさを重視すると、間違いなく後者であるair-preview.vimなのですが…。

airを固有名詞に選んだ理由

固有名詞とは

同じ種類に属する事物から一つの事物を区別するために、それのみに与えられた名称を表す語

airの意味

空気、大気、空、天空

私にとっては、空気という印象が強い単語です。

しかし、あくまでネーミングのための固有名詞として使っています。この場合、airが付いているものは、私のオリジナルみたいなものを意味するのでしょうか。

個人的には、MacBook Airから連想して使いはじめました。意味は特に意識していないですね。