「誰がこんなネーミングにしたんだ……。」プログラミングのネーミングルールを決める時に参考にしたい情報まとめ
サイトのメンテナンスにおいてしばしばネックになるのは、どんなネーミング・構成で制御しているのか分からなくなってしまうことです。しっかりと基準に則った、誰がいつ見てもわかりやすいネーミングでコーディングしていくことは、非常に重要なことです。
今回は、プログラマーがネーミングを考える際に参考にしたいサイトを選んでご紹介いたします。
1. codic - プログラマーのためのネーミング辞書
様々なサイトに紹介され、「ネーミング」で検索しても上位に表示される素晴らしいツールです。例えば、Webサイトの背景に動画を設置する際に、class名をどうしようか悩んだとします。そこでcodicに「背景動画」と入力すれば「background_videos」と提案してくれます。提案されたネーミング以外にも、その他の候補も出てきます。
考える労力を省くことができるという点で優れていますが、何より人に依存しないでネーミングができるところが素晴らしいと思います。これを使ってネーミングを付けるようにしようというルールを敷けば、長くて覚えづらいルールに照らしてチェックする必要もありません。
こちらのツールのみでも十分便利と言えるのですが、考え方を様々な観点から理解するためにも、以下よりご紹介するサイトも是非チェックしてみてください。
2. うまくメソッド名を付けるための参考情報
http://qiita.com/KeithYokoma/items/2193cf79ba76563e3db6
Qiitaからです。codicが必要なネーミングをダイレクトに提案してくれるのに対して、こちらはネーミングをカテゴライズして事例とともに紹介してくれる、整理に役立つ情報です。「状態に関するメソッド」「データに関するメソッド」等、意味を参照しながらベターな単語を選ぶことができるのでオススメです。
3. 今さら聞けない、変数や関数の命名規則と、まず覚えるべき英単語200
まずエンジニアとして覚えておきたいキーワードを、その使い方と一緒に200個羅列してくれている記事です。カタカナ読みも記載されているので、普段の会話の中で言い間違いといった齟齬もがなくなるはず。
使い方の基本的なルールも冒頭に記載されていて、メリット・デメリットがわかるようになっているのも嬉しいポイントです。
4. いまさら聞けない「コードの英語」超入門
http://techlife.cookpad.com/entry/2015/08/31/140749
クックパッドの開発者ブログからです。エンジニアの方なら、クックパッドのブログを一度は拝見されているのではないでしょうか。過去分詞・現在分詞の使い方だったり、ネイティブスピーカーのレビューをされているところだったり、充実した内容と言えます。
ネーミングについての読み物が欲しい方は、「超入門」とはなっていますがこのページから多くのものが得られると思います。
5. Naming -名前付け-
こちらもQiitaの記事からです。「主な戻り値」もセットにしたリストがまとめられています。参考書籍に名著『リーダブルコード』他、様々な書籍が上がっていますが、非常に整理されていて短い記事となっています。
6. プログラミングでよく使われそうな英単語 - Variety wiki
今回ご紹介するものの中で一番簡素にまとまっているページです。とりあえず全体間をサッと眺めたい方には良いと思います。
7. プログラマなのに知らなかったら恥ずかしい英単語集
http://qiita.com/usatie/items/b41adf8114188406d2b8
こちらも『リーダブルコード』を参照とした記事です。類語でまとまっているので、こちらも全体間を知りたい方に丁度良いと思います。
8. クラス名・関数名によく使われる英単語
http://d.hatena.ne.jp/fortrand/20130514/p1
使われている頻度で単語を羅列しています。エンジニアのキャリアを始めたばかりの人であれば、どういった単語を使うことが一般的なのかを知ることは、難しいと思います。この記事を見ると、そういった指標も見られるので一度参照されることをオススメします。
9. 関数名によく使われる英単語(動詞)の意味とニュアンス
http://php-archive.net/php/words-in-function-names/
英語の辞書を参照しながらまとめられている記事です。カテゴライズがやや大きめなので、英語の感覚を持っていらっしゃる方には有機的に理解しやすいまとめ方となっているかもしれません。
10. 新人コーダーに知っておいて欲しい命名規則の考え方 [画像・ID・class名]
http://html-coding.co.jp/knowhow/tips/naming-rule/
新人コーダーに向けたネーミングが学べる記事です。「半角英数字のみ使う」など、より基本的な内容から扱っているので、はじめての方にはオススメです。
まとめ
冒頭でもお伝えした通り、ネーミングはメンテナンスする際、非常に重要になります。
実際にコーディングをする前、特にチーム制の場合には「どのサイトのルールを踏襲するか」を決めてしまった方が良いと思います。
ぜひ上記ピックアップしたものを参考にネーミングについて改めてルールを設けてみてはいかがでしょうか。
このニュースを読んだあなたにオススメ
ノンプログラマーがWebサービスやツールを作るまでの備忘録20選
無料で学べる人気プログラミング学習サイト21選
プログラミングするならこれ!無料で使えるおすすめのテキストエディタ6選