ruby - クラス/プロシージャ/オブジェクトのないスクリプトの RDoc

Question

内部に構造がない場合、RDoc またはその他のドキュメント ジェネレーターを使用して Ruby スクリプトをドキュメント化することは可能ですか?

Answer 1

RDoc は、構造を持つコードで使用するために設計されました。あなたが話していることの種類については、Roccoを見るかもしれません。(このリンクは、Rocco が生成したドキュメントの例でもあります。)

Rocco は Docco の Ruby 移植版です。Doccoは、100 行にも及ぶ手っ取り早いプログラミング スタイルのドキュメンテーション ジェネレーターです。

Rocco は Ruby ソース ファイルを読み取り、注釈付きのソース ドキュメントを HTML 形式で生成します。コメントはMarkdownでフォーマットされ、注釈効果を与えるために構文が強調表示されたコードと一緒に表示されます。このページは、Rocco を独自のソース ファイルに対して実行した結果です。