書き方

基本

行コメント(#)の後にドキュメントを記述する。 空白のインデントによってRDのようにパラグラフを認識する。

ブロック => パラグラフ => インライン

ブロック

コメント行の連続によってブロックが構成される。

ファイルの先頭にあるブロックがファイルのページにドキュメントとして表示される。

クラス定義の前にあるブロックがクラスのページにドキュメントとして表示される。

メソッド定義の前のブロックがメソッドのドキュメントとして表示される。

著作権、ライセンス表示

# Author::    Dave Thomas  (mailto:dave@x.y)
# Copyright:: Copyright (c) 2002 The Pragmatic Programmers, LLC
# License::   Distributes under the same terms as Ruby

Author,CopyRight,License以外にも::で区切ればなんでも表示できる。

パラグラフ

ヘッディング

RDのように

= Head1
== Head2
=== Head3
==== Head4
===== Head5
====== Head6

で、<h1>〜<h6>になる。7個以上書くと<h6>になる。

ヘディング行は連続すると結合してしまうので空行やテキストブロックを入れること。

= Head1
== Head2

は、<h1>Head1 Head2</h1>になってしまう。

インライン

URL風の文字列は自動的にリンクになる(mailto:,http:,ftp:)

クラス名、メソッド名を書くと自動的にリンクになる。

*word*

太字(<b>word</b>)

_word_

強調(<em>word</em>)

+word+

タイプ文字(<tt>word<tt>)

wordは ([A-Za-z]+) なので注意。

HTMLタグ風の表記(<em></em>,<i></i>,<b></b>,<tt></tt>)が使える。しかし、入れ子には未対応。

リスト

順序なしリスト <ul>

 * text

- text

順序付きリスト <ol>

1. text

説明リスト <dl>

[label] text

ノート <table>

label:: text

コマンドライン

rdoc.rb [オプション] [ファイル名]

rdoc.rb --title Win32::GuiTest \
  --template kilmer \
  --main Win32::GuiTest \
  --charset Shift_JIS \
  lib/win32/guitest.rb

オプション

--title txt

出力するHTMLのタイトルを指定(txt)する。 無指定時は'RDoc Documentation'になる。

--template name

テンプレートの名前を指定。 テンプレートはrdoc/generators/html_template以下にある。

standard

上段が3列(Files,Classes,Methods)、下段にDocument。メソッド名をクリックすると 新しいウィンドウにソースが表示される。

kilmer

左側が3行(Files,Classes,Methods)、右側に2行(Document,Source)。 MoonWolfはこっちのほうが好き。しかし、Sourceって何だろう?

  • メソッド名の右にでるSrcをクリックすると該当メソッドのソースが表示される。
--main name

インデクスでどのページ(ファイル/モジュール/クラス/メソッド)を開くか指定。

rdoc.rb --main Win32::GuiTest::Window
--charset charset

出力するHTMLのcharsetを指定する。

--op dir

出力ディレクトリ指定。 省略時は'doc'

--fmt fmt

出力フォーマットを指定する。 (chm, html, ri, xml)

--include dir[,dir...]

include があった時に検索するディレクトリを追加します。 複数回記述できる。

--show_hash

A name of the form #name in a comment is a possible hyperlink to an instance method name. When displayed, the '#' is removed unless this option is specified

--diagram

Generate diagrams showing modules and classes

--all

include all methods (not just public) in the output

--quiet

don't show progress as we parse

--version

display RDoc's version

--fileboxes

classes are put in boxes which represents files, where these classes resides. Classes shared between more than one file are shown with list of files that sharing them. Needs --diagram to be turned on. If not, this option is silently discarded. Experimental.



The RWiki