ruby-list

新井です。

From: Koji Arai <JCA02266@nifty.ne.jp>
Date: 24 Aug 2000 01:17:31 +0900
Subject: [ruby-list:24433] Re: RubyDocumentationProject(仮)

> 新井です。

> ま、よろしければ [ruby-list:19934] からのスレッドは参照して
> みてください。

現状の MethodList に関して、書き方をまとめてみました。叩き台
ですが書き方にポリシーのない方はこれに従っていただくというこ
とで。

# るびきちさん: RDPのページからこのメールへのlinkをつけてい
# ただけますか？

あと、RD の書き方がわからないけど、プロジェクトには貢献した
いという方はベタなテキストでもよいと思います。

ruby-man.rd から以下を抜きだして持っていってください＞るびきちさん

dbm.rd
kconv.rd
getopts.rd
parsearg.rd
ftplib.rd (obsolete)
socket.rd
thread.rd

------------------------------------------------------------------------
RD の MethodList について

 MethodList の書き方は、現状以下の書き方を推奨しています

 基本的に
   ・rubyでのメソッド定義に似ている
   ・ruby界におけるメソッド表記法に似ている
 です。

  --- Class.method(arg1, arg2)
      クラス／モジュールメソッド／モジュール関数であることを示します。
      "." ではなく "::" と書きたい方もいらっしゃるでしょうが、
      現状の取り決めは "." です。

  --- Class#method(arg1, arg2)
      インスタンスメソッドであることを示します。

  --- Module::Class#method
      ネストしたクラス／モジュールのインスタンスメソッドの例です。

  --- Class::CONSTANT
      クラス／モジュール定数であることを示します。

  --- function#method()
      このように "function#〜" は 関数を表します。

      function# はかなり冗長な気がしますが。当面はこれで行きま
      す。(後々の取り決めで変更があっても機械的書き換えができ
      るように)

  --- Class#method
  --- Class#method2
      2つ以上並べて記述した場合それらがエイリアスであることを示します

  --- Class#method
  --- Class#method(arg)
  --- Class#method {|a, b| ... }
      説明の都合上、複数の引数形式を書いた方がわかりやすい場合
      もこのように並べて書きます。

  --- Class#method(arg1, arg2=nil)
      これは、2番目の引数が省略可能でデフォルト値がnilであることを示しま
      す。

  --- Class#method(arg1[, arg2])
      これも、同様に2番目の引数が省略可能であることを示します。
      こちらの書き方の方が、初期値指定よりも都合がよい場合があ
      ります。

  --- Class#method(arg1, *arg2)
  --- Class#method(arg1[, ...])
      これは、引数を1つ以上指定できることを示します。

  --- Class#[](arg)

  --- Class#[]=(arg1, arg2)
      self[arg]、self[arg1] = arg2 のような配列参照／代入形式の
      メソッドは、このように書きます。

  --- Class.[](arg)
      クラス自身の演算子形式メソッドは"."で書きます。

  --- Class#+@
      単項演算子は、このように。

  --- Class#+ arg
      二項項演算子は、このように書きます。

  --- $var
      グローバル変数です。

なお、RDtool 自体は、MethodList を

・ `('、 `{'、 ` '(空白) より前の語をラベルとみなす

と扱います。それ以外ではHTML出力では見た目のために

・ ラベルでない部分の語はフォントをイタリックにして引数らしくする
・ "function#" は隠す
・ 演算子形式のメソッドは Class#[arg1] = arg2 と見た目を変える

といった処理を行います。
------------------------------------------------------------------------

--
新井康司 (Koji Arai)

Thread

Prev Next

In This Thread

Prev Next

[#24065] Perl/Ruby Conference in Kyoto — Noritsugu Nakamura <nnakamur@...>

[#24068] continuation in thread — Takaaki Tateishi <ttate@...>

[#24070] 謎の Segmentation fault — YASUI Kentarow <kenyasui@...>

[#24073] Ruby で使える XML パーザーについて — Takaharu Yamashita <takayan@...2.so-net.ne.jp>

[#24082] Array#assoc — Kazuhiro NISHIYAMA <zn@...>

[#24086] // は偽？ — rubikitch <rubikitch@...>

[#24088] mod_ruby-0.1.8 and postgres-0.6.1 — Teruki Shigitani <shigi@...>

[#24095] p <obj> の返値 — ARIMA Yasuhiro <fit0298@...>

[#24102] Perl/Ruby Conference 開催決定 ! — matz@... (Yukihiro Matsumoto)

[#24109] gtk+ なクラスブラウザ — kadu <kadu3@...16.alpha-net.ne.jp>

[#24112] ある method がどこで def されたか調べる方法 — Yasushi Shoji <yashi@...>

[#24123] CGI::pretty — Kazuhiro NISHIYAMA <zn@...>

[#24125] rbcw145.zip に lib/net/telnet.rb がない — Kazuhiro NISHIYAMA <zn@...>

[#24126] embedded Ruby for Verilog — "Kikutani, Makoto" <kikutani@...>

[#24134] File.rename error message — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#24149] methods — Kazuhiro NISHIYAMA <zn@...>

[#24156] 改行コードが… — Hagemu Higuchi <hahiguc@...11.odn.ne.jp>

[#24158] Hash の初期値に [] を使う — Mitsuhiro Kondo <kondo@...>

[#24174] ruby によるバグ追跡システム — 堀川 久 <vzw00011@...>

[#24176] FreeBSD ports — "Akinori -Aki- MUSHA" <knu@...>

[#24186] media watch 2000.08.08 — Noritsugu Nakamura <nnakamur@...>

[#24191] drb.rb: 0x40155740 is recycled object (IndexError) — Hideto ISHIBASHI <hideto-i@...4u.or.jp>

[#24193] FreeBSD ports #2 — "Akinori -Aki- MUSHA" <knu@...>

[#24195] HTML 関連ライブラリ — MoonWolf <moonwolf@...>

[#24206] iconv 0.4.2 pre3 — nobu.nakada@...

[#24210] install guide — gotoken@... (GOTO Kentaro)

[#24222] FreeBSD ports #3 — "Akinori -Aki- MUSHA" <knu@...>

[#24226] Ruby で日本語とスペイン語の混在文は？ — Kakuzi TAKAHASI <ktaka@...>

[#24230] Ruby 1.4.6 repacked — matz@...

[#24249] no oper in %Ruby — Shugo Maeda <shugo@...>

[#24250] コマンドの STDERR への出力を補足したい。 — Kengo Nakajima <ringo@...>

[#24255] DBM failed on cygwin version — Ataru NAKATA <anakata@...>

[#24257] デバッグ用にデータをダンプしたい — Mitsuhiro Kondo <kondo@...>

[#24259] RDindex 1.1.0 — rubikitch <rubikitch@...>

[#24261] — Shigeki Shiroshima <pakshima@...>

[#24267] What's the biggest Ruby development? — Dave Thomas <Dave@...>

[#24268] はじめまして & cygwinでconfigure不能 — "Mitsuo Igarashi" <mitsu5@...>

[#24270] 1.4.6 cgi-lib — Masatoshi SEKI <m_seki@...>

[#24271] Tiki, ruby-1.4.6 — Masatoshi SEKI <m_seki@...>

[#24272] How to read buffered data? — Tanaka Akira <akr@...17n.org>

[#24274] About sub with multilines — kiri@...

[#24280] RE: [ruby-list:24268] cygwinでconfigure不能:cygwin1.dllの問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24284] 拡張ライブラリ作成時の NULL ポインター — Akimichi Tatsukawa <akimichi@...>

[#24291] media watch 2000.08.18 — Noritsugu Nakamura <nnakamur@...>

[#24294] grep(!/hoge/)? — kiri@...

[#24298] Re: cygwin で configure 不能 :cygwin1.dll の問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24299] Where MDArray? — kiri@...

[#24305] Status: header and cgi.rb — Yasuhiro Fukuma <yasuf@...>

[#24314] はじめまして ...? — polygon <kiyose@...>

[#24316] 画像のサイズを調べるスクリプト — kadu <kadu3@...16.alpha-net.ne.jp>

[#24317] undefined cygwin_dll_entry — polygon <kiyose@...>

[#24321] shttpsrv — TAKAHASHI Masayoshi <maki@...>

[#24323] HP-UX 上での ruby1.4.6 make getaddrinfo.c err — yasuaki onishi <yasuaki@...4u.or.jp>

[#24324] ruby の発展の為に — "Mitsuo Igarashi" <mitsu5@...>

[#24329] Coerce between Range and Boolean — NISHIKAWA <nyasu@...3web.ne.jp>

[#24341] install guide draft — gotoken@... (GOTO Kentaro)

[#24357] FreeBSD ports #4 — "Akinori -Aki- MUSHA" <knu@...>

[#24378] bin package on win/dos — Noritsugu Nakamura <nnakamur@...>

[#24384] erb-1.3.1 — Masatoshi SEKI <m_seki@...>

[#24399] 「 Ruby プログラミング入門」査読者募集 — Shin-ichiro Hara <sinara@...>

[#24430] (RDP) Engurish ftools.rd — gotoken@... (GOTO Kentaro)

[#24439] HotLinks — NISHIKAWA <nyasu@...3web.ne.jp>

[#24447] (RDP) tempfile.rd — Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>

[#24464] Tips for Perl -> Ruby — kiri@...

[#24469] レンタルサーバで eruby — Tokita Kousui <ktokita@...>

[#24473] RD for(?) Cygwin — polygon <kiyose@...>

[#24491] Re: レンタルサーバで eruby — "Kahori Takeuchi" <EB89012@...>

[#24499] FreeBSD port: x11-toolkits/rubytk — Yasuhiro Fukuma <yasuf@...>

[#24501] media watch 2000.08.24 — Noritsugu Nakamura <nnakamur@...>

[#24515] MSWin Ruby on Windows2000 — arton <arton@...>

[#24520] wildcard arg for ruby1.4 — arton <arton@...>

[#24522] (RDP) readline — Koji Arai <JCA02266@...>

[#24531] RD 質問 — Koji Arai <JCA02266@...>

[#24550] Array への nil の代入について — Kenya Ogata <k_ogata@...>

[#24556] 埋め込みドキュメント仕様 RubyDoc( 提案) — MoonWolf <moonwolf@...>

[#24559] 配列内のオブジェクトの配列内のオブジェクトの関数 — Yasuki <yasuki@...>

[#24565] Ruby FAQ — Kazuhiro NISHIYAMA <zn@...>

[#24592] perl to ruby — "Yasuyuki Imai" <waver@...3.ttcn.ne.jp>

[#24625] member list was crashed — matz@... (Yukihiro Matsumoto)

[#24631] Re: RubyDocumentationProject( 仮 ) — TAKAHASHI Masayoshi <maki@...>

[#24174] ruby によるバグ追跡システム — 堀川　久 <vzw00011@...>