ruby-dev

高橋征義です。

keiju@ishitsuka.com (石塚圭樹) wrote:
> >最近PHPを使い始めてて、PHPDoc(JavaDocもどき)がわりといい感じ
> >だったので、Rubyでもこういう感じに書けるといいかなあ、と
> >思って、それっぽいものを少し書いているのでした。
> 
> RDってそういうものかと思っていたのですが, そうでもないのかな?

これなんですが、いくつかのライブラリ(xmlparserとか)に
RDでメソッドについての簡単なコメントを書いてみた経験から
言うと、特に数行程度の短いコメントの場合、RDだと読みにくく
なってしまいがちみたいなんですよ。

RDの場合、単体のドキュメントにするか、ソース内に含めるなら、
前または後ろにまとめてつけるのようなタイプの書き方をする
べきなのではないか、というのが暫定的な結論です。
例えば、リファレンスマニュアルやRDPはRDに向いているけど、
作成中のソースに都度コメントを書くなら、RDよりもJavaDoc
もどきの方が向いているかも、と。逆に、そこからRDのメソッド
リファレンス形式のドキュメントを生成して、plain textとしては
それを配布することにする、なんてのもありかなと思います。

まあでも、この辺は個人的な見解なんで、異論のある人もいる
とは思います。はい。

> >というか、任意の式をメソッド引数のデフォルト値として書かれると
> >parseするのは辛すぎますね……「禁止禁止」というわけにもあんまり
> >いかないでしょうし。やっぱり引数はまじめにparseしない方が
> >幸せへの道かも。
> 
> でしょうね. それだけのためにRubyのパーザ作ることになってしまう(^^;;;

Daveの結論もそうだったみたいで、RiR待ちだそうです。
でも、どーせ型情報もないんだし、まじめにparseできたところで
Javaなどに比べればあまりメリットないかもしれませんよね。
だったら、文字列で十分か、と。

> ## でも, 今ちょっと立て込んでいるので、もうちょっと待ってください.

私もしばらく立て込んでいるので、他に困っている方がいなければ
いつでも構いません :-)

高橋征義 (TAKAHASHI Masayoshi)   E-mail: maki@open-news.com

Thread

Prev Next

In This Thread

Prev Next

[#14614] 大小文字を無視した比較で ' 帰 ' == ' 蟻 ' ? — "K.Umakoshi" <pegacorn@...>

[#14621] suidruby — nobu.nakada@...

[#14626] ARGV — WATANABE Hirofumi <eban@...>

[#14636] Re: [REQ] String#slice(re, n) — Minero Aoki <aamine@...>

[#14642] getnameinfo? — Masatoshi SEKI <m_seki@...>

[#14658] Socekt::SOL_TCP -> Socket::IPPROTO_TCP — m_seki@...

[#14662] How to abondon saved uid privilege — nobu.nakada@...

[#14668] = in conditional — "Akinori MUSHA" <knu@...>

[#14683] ruby 1.7 の eval.c で warning — Kazuhiro NISHIYAMA <zn@...>

[#14697] Forward: [ruby-talk:20735] bug in tk.rb? — matz@... (Yukihiro Matsumoto)

[#14698] Forward: [ruby-talk:20820] Ruby/Tk core dump — matz@... (Yukihiro Matsumoto)

[#14710] SEGV at digest.c — Tietew <tietew@...>

[#14712] extra puts() at digest.c — Tietew <tietew@...>

[#14716] CGI#header bug — Shugo Maeda <shugo@...>

[#14730] ruby-lex.rb: get value from TkSTRING and TkCOMMENT — TAKAHASHI Masayoshi <maki@...>

[#14741] Forward: [ruby-talk:20957] Re: Is Ruby/Tk being maintained? — matz@... (Yukihiro Matsumoto)

[#14742] Forward: [ruby-talk:20964] Re: Is Ruby/Tk being maintained? — matz@... (Yukihiro Matsumoto)

[#14743] [BUG] $_ on thread switching — nobu.nakada@...

[#14749] forwardable.rb : call Kernel.raise — Kenichi Komiya <kom@...1.accsnet.ne.jp>

[#14754] regex.c について — Osamu Shigematsu <shige@...>

[#14765] DISTCLEANFILES in mkmf.rb — nobu.nakada@...

[#14766] Enumerable#inject — OZAWA -Crouton- Sakuro <crouton@...>

[#14768] rational precision 対応 — keiju@... (Keiju ISHITSUKA)

[#14782] coredump in mod_ruby's configure.rb — "Akinori MUSHA" <knu@...>

[#14786] [PATCH] File.utime fails occasionally — nobu.nakada@...

[#14793] Array is not Comparable — "Akinori MUSHA" <knu@...>

[#14798] freeing thread stack etc. (Re: ruby 1.6.5 preview) — matz@... (Yukihiro Matsumoto)

[#14809] WAIT_SELECT value with multithread — nobu.nakada@...

[#14810] ruby1.6.5/marshal.c — "Shin'ya Adzumi" <adzumi@...>

[#14813] option -d differ with --debug — Koji Arai <JCA02266@...>

[#14816] Generator — "Akinori MUSHA" <knu@...>

[#14823] ruby-1.6.5 MacOS X 10.1 patch — SHIROYAMA Takayuki - <psi@...>

[#14824] mailread.rb — Tietew <tietew@...>

[ruby-dev:14769] Re: ruby-lex.rb: get value from TkSTRING and TkCOMMENT

Thread

In This Thread

[#14823] ruby-1.6.5 MacOS X 10.1 patch — SHIROYAMA Takayuki　- <psi@...>