はじめに
開発プロジェクトを標準化させようと日々色々と考えております。
そんな中、コーディング規則の一つである命名規則を決めるうえで役立つ方法・ツールなどなど
記事にまとめてみます。(備忘録も含め)
新規で追加する関数名に悩むとき、通常の翻訳サイトだと物足りないこともあります。(そもそも思いつかないこともある。)
ステップ1:既存プロジェクトの開発ならプロジェクトの規則・文化を考慮する
もし既存プロジェクトにおいて新規関数や変数を作ろうとしている場合、以下は最低限意識した方が良いと思います。
・そのプロジェクトでの命名規則
・「こういった機能ではこの単語を使いましょう!」というような暗黙の文化
既存プロジェクト内のソースコードと全然異なる命名をすると、同一機能のgrepで引っかからなくなる等デメリットが発生します。
必ず確認しましょう。
ステップ2:命名
命名する際の参考サイト・記事
・プログラミングでよく使う英単語のまとめ【随時更新】
⇒基本となる単語情報は対義語や意味合い、ユースケース付きでシンプルかつ丁寧に説明されています。記事内の検索性もよく、非常に便利なサイトといえるでしょう。
また、単語の話だけでなく、使わない方がいい単語や記法の説明、命名に対する考え方等の説明もされており、タイトルとなっている英単語に留まらない「命名」に関する参考資料です。
・Codic
⇒プログラマ向けの辞書サイトです。
UIはこんな感じになっており、翻訳時の記号 "_"を使うのか"userAccount"のように大文字区切りにするか等の記法も設定出来ます。
デフォルトでも参考になりますし、ログインすれば辞書をカスタマイズすることも出来るので、自分やプロジェクト内での開発用辞書として育てていくことも出来そうです。
関数や変数のネーミングに悩んだら「codic」に日本語名を入力するとある程度解決するかも知れません。
プログラミングで変数名や関数名のネーミングに迷ったときに便利なカンニングペーパーまとめ
「命名」という観点で色々なサイトを紹介しており、かなり勉強になります。上記codecの使い方もガイドされてます。
ステップ3:見直し
一般的な翻訳サイト
翻訳サイトを使ってスペルミスやそもそも単語の意味が違っていないかチェックしましょう。
・google翻訳
⇒google検索で「XXX(日本語名) 英語」検索すると自ずとgoogle翻訳が開かれるのが便利。違和感あれば別のサイトをチェックしましょう。
・Weblio辞書
⇒意味合いが似た単語の候補をいくつか挙げてくれるので、プログラミングとして、プロジェクトとして違和感のないものを選ぶことが出来ます。(何故か検索候補に上がり易い。)
・アルク
⇒使いやすいが、Weblioでよいかも。(Weblioのほうが検索上位に来やすい)
その他命名に関する参考サイト・記事
・[ソフト開発]きれいなソースコードを書くために必要な、たったひとつの単純な事
⇒「プログラミングでよく使う英単語のまとめ【随時更新】でも取り上げられた参考リンク記事の一つ
・クラスの命名のアンチパターン
⇒アンチパターンをまとめたもの。良記事です…!
・プログラミングの英語表現 / 文章作成に迷ったら「クオートで囲ってGoogle検索」
⇒命名の妥当性を確認するひとつの指標として、簡単に実践できるgoodアイディア。自分も実践しています。
まとめ
これらに則り、プロジェクトごとにしっかり命名ルールを書いて「暗黙の」ルールまでなくせたらかなり標準化が進みそうです。
まず現状、習慣として少なくともスペルミスはしっかり見直しましょうっていう部分が必要そう。(自分含め)
参考:
・プログラミングでよく使う英単語のまとめ【随時更新】
・[ソフト開発]きれいなソースコードを書くために必要な、たったひとつの単純な事
・クラスの命名のアンチパターン
・プログラミングの英語表現 / 文章作成に迷ったら「クオートで囲ってGoogle検索」