BLOG
ブログ
  • TOP
  • BLOG
  • プログラミングで使われるメソッドの命名規則

プログラミングで使われるメソッドの命名規則

プログラミングで使われるメソッドの命名規則

CONTENT

こんにちは。エンジニアのAです。

今日は業務の経験から学んだメソッドの命名規則について、簡単にまとめていこうと思います。

オブジェクト指向プログラミングでは複数のメソッドを組み合わせてプログラムを構成するため、多くのメソッドが必要になります。

このときにメソッドに統一された命名規則が無いと、各メソッドの処理内容が判断し辛くなり、修正や改修の際に余分な工数が掛かる可能性が生まれます。

処理内容に合わせた命名規則を定めることで、後から見直した場合や他の人が修正する場合でも内容が把握しやすいコードを実装するようにしましょう。

参考として、良く使用されるメソッド名のパターンを幾つか挙げていきます。

・validate~:値の型や内容が正しい状態か判断する
 例)validateInputParam(入力した値が正しいか)

・is~:オブジェクトの状態が期待したものか判断する
     例)isPastDate(判定対象の日付が過去日か)

・decide~:値を決定する
     例)decideInsertNumber(登録する数を決定)

・update~:更新処理を実行する
  例)updatePrice(価格を更新)

上記はあくまでも命名規則のほんの一部です。また、進行中のプロジェクトに途中から参加した場合や、既存のシステムの修正を行う場合などでは、上記と異なる命名規則が使用されていることもあり得ます。

プロジェクトの状況も加味した上で最適な命名ができるように、常に考えて作業するようにしていきましょう。