プラグインのメソッド名のつけかた

tips_plugin_add_method

メソッド名は、プラグインの顔とも言えるので慎重に考えることをお奨めします。

  • 短め
  • 機能を想像しやすい
  • すでにある他のプラグインとの名前の重複は避ける(機能を上書きする場合は同じ名前にする)
  • すでにある他のプラグインと似たような機能の場合は似たような名前にしてもよい

といったところがポイントになります。

また、メソッド名は基本的に小文字で始めれば良いぐらいの決まりしかないのですが、単語の区切り 方は2通りあります。1つは'_'でつなぐ方法ともう一つは単語の区切りを大文字にする方法(Camel Case)です。

def hoge_fuga
end

def hogeFuga
end

これについては人によって好き嫌いがあり、JavaなどでもCamel Caseが使われていることから過去に も何度か論争の種になっているのですが、実は、Ruby的には前者が好まれます。実際のところtDiary 本体でもそのようになっています。

この辺のRuby的なコーディング手法の指針が欲しい人は、高橋征義さんによるRubyCodingConventionが参考になるでしょう。

ちなみに、Javaでいうところのgetter/setterもあまり好まれません。

def get_hoge
  @hoge
end

例えば、上記の場合は

def hoge
  @hoge
end

あるいは 

attr_reader :hoge

というようにアクセッサを使う...でも、これはプラグインの場合はあまり使わないかな。

更新日時:2004/04/28 01:30:53
キーワード:
参照:[tDiary関係]