スタッフブログ

  • 最新配信
  • RSS

メソッドの命名規則

 : 技術全般 2008/9/11 2:30

Blogger's Avatar

haltです。 プログラムにおいて、名前をつける事は非常に重要な意味を持ちます。 (半年後の自分も含めた)他の人が触れるプログラムなら多少時間が かかってもわかりやすい変数名、わかりやすい関数名をつけるべきです。 が、実際は最適解が見つからず適当につけてしまいがちです。 PEARのコーディング規約には、camelbackで書くように。等のキャピタライズに関する支持はあっても具体的にどういうメソッド名にするべきかは書かれていません。 isを使う時はbooleanで返すなどのルールは他のコードを見てみよう見真似でやっていたのですが他にどんなルールがあるのかとgoogleで検索したら以下のルールが見つかったので紹介します。 [blockquote] http://www.okapiproject.com/java/java_codeconventions/jcc_naming.htm 2.9.4.boolean 変数を返すメソッド boolean 変数を返すメソッドについては、「is + 形容詞」「can + 動詞」「has + 過去分詞」「三単現(三人称単数現在)動詞」「三単現動詞 + 名詞」のいずれかの名称をつけます。特に動詞は三単現以外の動詞は利用してはいけません。また、true の場合がどちらであるか判別しやすい名前にするために通常は true の場合を名称にします。 [/blockquote]
isEnabled()
canGet()
hasCanged()
contains()
containsKey()
このルールはJava向けのようですが、命名規則に関してはPHPでも通用します。あらかじめ規約を決めておく事で名前から関数の動作を予測できるようになり、コードの理解が早くなるので、こういったルールを覚えておき、自分のコードに反映させていくと良いのではないでしょうか。

トラックバック

スタッフブログ最新
カテゴリ一覧

〒104-0061 東京都中央区銀座1丁目3番3号 G1ビル7階
お問い合わせ TEL 03-3524-8860

Copyright(c) 2012 RYUS.All Rights Reserved.