|
From: Kouhei S. <ko...@co...> - 2011-07-23 15:29:42
|
須藤です。 In <CAM...@ma...> "Re: [ruby-gnome2-devel-ja] 命名規則などの提案" on Sun, 24 Jul 2011 00:11:19 +0900, Masaaki Aoyagi <mas...@gm...> wrote: >> うーん、でも、ドキュメント化されていれば杞憂になるのかなぁと >> いう気もします。今はここに書いてありますが、これから書くなら >> Hikiじゃないところの方がいいですよねぇ。 >> http://ruby-gnome2.sourceforge.jp/#For+Developers >> http://ruby-gnome2.sourceforge.jp/hiki.cgi?How+to+Implement+Ruby-GNOME2 > > yardドキュメントを埋め込む方向で今やっているので、ソースに書くのがいいのでしょうか? YARDであれば、ソース以外にテキストファイルもドキュメントに加 えられるので、テキストファイルに書く方がよいと思います。たと えば、これもソースとは別のファイルに書かれていると思います。 http://rubydoc.info/docs/yard/0.7.1/file/docs/GettingStarted.md > TARGET_NAMESPACEを隠蔽しようとしているのは、1ファイル=1名前空間を強制させる意味が大きく > ちょっとやりすぎ感は確かにあるのですが、この方式にしたいです。 わかりました。 では、そうしましょう。 >> LispとかRuby本体ではpredicateな関数・メソッド(述語。真偽値 >> を返す関数・メソッド)に?をつけるので、_qではなく_pの方がい >> いかなぁと思いました。 > > predicateと言うのですか。 > では、_pでいいですかね。 では、_pにしましょう。 >>> * ! 付きメソッドの関数名は、末尾に ! の代わりに _e を付ける >>> 使用マクロ:G_DEF_METHOD_E >> >> eはexclamationの略ですよね。 >> Ruby本体ではbangを使っているのでそっちにあわせる方がいいかなぁ >> と思いましたが、_bだとなんだかわからないんですよねぇ。_bang >> でもいい気がしますが、1文字がいいんですよね。うーん。 > > ! 付きメソッドは、それほど多くないはずなので、_bangでいいですかね。 では、こちらは_bangで。 > すみません、今調べたらrg_もrgb_も使っている箇所がありましたが、どうしましょう? > マクロのprefixも新たにしてマクロの整理も行う方向に持っていけたらベストでしょうか。 そうですね。 ざっと見てみたら、rg_よりもrbg_の方が多いので、rbg_に統一す る方向でいきましょう >> やり過ぎ感をもう少し書いておくと、一回リポジトリからremoveす >> る前のRuby/GIO2みたいな方向になっていくのを危惧しています。 >> ソースコードを見てもらえばわかると思うのですが、「たしかに >> Rubyの拡張ライブラリを作っているCなんだけど、違う言語に見え >> る」、という感じになっています。 >> >> r3724で削除したので、これで見れると思います。 >> http://ruby-gnome2.svn.sourceforge.net/viewvc/ruby-gnome2/ruby-gnome2/trunk/gio/?pathrev=3723 > > なるほど、似たようなことをやってらっしゃいますね。。。 > ただ、自分が考えているのは実装やドキュメントの不足チェックとテンプレート生成を自動化することが主な目的なので、 > 関数定義の部分まで手を突っ込むことはないと思います。 わかりました! では、この方向でいきましょう! |