変数名の付け方に時間がかかる

Question

すごい初歩的な質問なのですが、いつも変数名やメソッド名などを付けるのに悩み、そこに結構時間が取られてしまいます。

シンプルで分かりやすい名前をすぐに付けれるようになるにはどういった訓練をすればよいのでしょうか。

Answer 1

どの言語にも言えますが、まずはその言語に最初から実装されている関数名等に倣うことです。
次に、PHPならPEAR等のライブラリがありますが、それらのソースを見て、どのような付け方をしているかを見るのがよろしいと思います。

以下、私がよく使う例ですので、参考にして下さい。

・毎日投稿されるコメントを集計目的でユーザーID指定で取得する
getDailyCommentForSummaryByUserId($userId)
※ByをWithにする方もおられますね。

・コメント操作など
addComment($comment) //追加
deleteComment($commentId) もしくは removeComment, eraseCommentなど//削除
setComment($commentId,$comment) もしくは replaceCommentなど//再編集

・ユーザーが存在するか
isUserExist($userId)

・ユーザーはプレミアム機能を使えるか
isPremiumUser($userId)
もしくは
canUserUsePremiumFunction($userId)

いずれにせよメソッド名の冒頭だけ見て、どのような処理をするか、どのような型が返ってくるか、を類推できることが重要です。
メソッド内部の変数はもう好きにして構わないと思います。

Answer 2

日本語から適切な英語に変換する際に悩んでいるのであれば
http://codic.jp/
のようなサイトを利用するのも手です。

Answer 3

基本的な操作の単語はまず覚えておいた方がいいと思います。
操作
add,delete,update,create,get,put,open,close,remove ...
判定
is,can,has ...
位置
first,last,next,prev(iouse) ...
対象
all, first, last, 単数複数（getUser(), getUsers()） ...

ただ分かりやすいって見る人で変わります。先日、
LogWhere()
というのがあって、なんじゃこれと思いましたが、これで分かるという人もいました。
自分なら、
makeLogSearchConditionString()
だったんですが。難しいものです。

Answer 4

私の場合は、すぐ思いつくことを諦めて、後で考えるようにしています。

コメントの中に TODO: などと記載しておいて、一日の作業を終える時に全て見直します。

分かりやすい変数名にする理由は、新しくコードを書くときのためではなく、後でコードを読み直す時のためですから、これは理にかなった方法だと思っています。

Answer 5

他人のコードをたくさん読むのが良いですね。
そして、自分なりに書き換えてみるのです。(どんなコードにも、改善の余地はあります。)
その中で、そのコードを書いた人の思いを想像します。
なぜ、このメソッドはこの名前なのか。なぜ、この変数はこの名前なのか。
慣れてくると、ああ、ここは手抜きだな、とかわかるようになります。

Answer 6

こんにちは。

PEAR::Manualの命名規約（リンク）や、Zend Frameworkの命名規約（リンク）を参考にしながら、
１）変数名に含めることができるのは英数字のみ（ただし、数字はおすすめできない）
２）つねに小文字ではじめる（グローバル変数の場合はアンダースコアからはじめる）
３）複数の単語で構成する場合は各単語の最初の文字を大文字にする
４）変数名は省略しすぎない（すくなくとも自分が何カ月か後にみた場合に意味がわかるていどに）
などといったことを意識しつつ命名することがだいじだと思います。

terushuさんの回答に書かれている例がとてもわかりやすいですね。