プログラミングのヒント

関数の名前の付け方

よい関数名を選ぶことは、よいコードを書くうえで欠かせない要素です。 関数に名前を付けるときは、次の点を意識してみましょう。

意味のある関数名を選ぶ

関数に名前を付けるときは、その関数が何をするのかをはっきりさせます。 たとえば、get(studentId, subject)という関数は意味のある関数名とはいえず、何をするのかがよくわかりません。 生徒の科目の成績を取得するのか、在籍状況を取得するのかもしれません。 getStudentGrade(studentId, subject)なら、関数が何をするのかを正確に伝えられるので、こちらのほうがよい名前です。

関数名を長くしすぎない

関数名を長くしすぎないよう気を付けましょう。 たとえば、checkStudentFailOrPassOrMeritOrDistinction(mark)は不必要に長い関数名です。 名前が長くなるほど覚えにくくなり、コンピューターの画面を占めるスペースも大きくなります。

関数名を短くしすぎない

逆に、関数名が短すぎても読み手を混乱させます。 たとえば、checkFPMD(mark)はよい関数名とはいえません。「FPMD」が何を意味するのか、すぐにはわからないからです。

誰にでもわかる名前を使う

関数名は、コードを読むすべての人に理解できるものであるべきです。 たとえば、DeathStar()のような難解な関数名は、本人には面白いかもしれませんが、その目的を伝えられず、コードを読む他のエンジニアを混乱させることがあります。

操作の命名は1つの慣習に統一する

同じことをする操作の名前は、1つの慣習に統一しましょう。 たとえば、生徒の名前を取得する関数をgetStudentName()と名付けたなら、生徒の成績を取得する関数には別の動詞を使わないようにします（たとえばretrieveStudentGrade()）。

同じ単語を2つの目的で使わない

たとえば、2つの数値の足し算にaddという名前をすでに使っているなら、複数の要素をコレクションに入れるときにもaddを使い続けないようにしましょう。 代わりにinsertやappendを使います。