良いコ-ドへの道―普通のプログラマのためのステップアップガイド

第2回名前付け重要。または、良いコードは良い名前から生まれるんです。―その3 良いメソッド名

良いメソッド名

良いメソッド名は、名前から機能が想像できます。メソッドは処理を行うので、メソッド名は「動詞」「目的語」になっていることが多いです。よく使用されるメソッド名には表2のようなものがあります。

●表2 Javaでよく使用されるメソッド名
メソッドの役割メソッド名
値の取得に関するメソッドgetXXX
値のセットに関するメソッドsetXXX
生成に関するメソッドcreate、build、make、genarate
初期化に関するメソッドinitialize、setupXXX
破棄に関するメソッドdestroy、dispose
状態の確認に関するメソッドcontains、exists

インスタンスメソッドは、⁠dateFormat.parse」のようにオブジェクト名と組み合わせて呼び出されるので、組み合わされたときに重複なく意味が通る名前にします。クラスメソッドとクラス名も同様です。

// ×parseDateStringだとクラス名のDateFormatと
//   dateが重複するため、若干冗長
DateFormat dateFormat = new DateFormat("yyyy-MM-dd");
Date startDate = dateFormat.parseDateString("2008-04-01");

// ○クラス名のDateFormatとメソッド名parseの
//   組み合わせで、何を行うのかは十分理解できる
DateFormat dateFormat = new DateFormat("yyyy-MM-dd");
Date startDate = dateFormat.parse("2008-04-01");

よく使用されるメソッドは簡潔で短い名前が良いという意見があります[4]⁠。たとえば、Javaのjava.utilVectorクラスで要素を取得するメソッド名は「elementAt」でしたが、java.util.Listクラスではより簡潔な「get」に変更されています[5]⁠。

おすすめ記事

記事・ニュース一覧