0

gemがインストールされている場合、rdocも生成され、次の方法でrdocにアクセスできることを確認しました。

gem server #->localhost:8808

インストールされたgemの使い方をruby-developerに説明する最も一般的な方法を考えています。私が(java)から来ているところでは、apidocs/howtosなどはすでにjarファイルに含まれています。

ある種のREADME.rdocファイル-convention(?)があるのを見て、おそらくそれがruby-developerがgemをダウンロードした後に探し始めるところだと思いましたか?

4

1 に答える 1

1

開発者によって異なります。

gem serverREADMEが大幅にマークアップされている場合(たとえば、大量のMarkdownまたはRDoc) 、ローカルのgemdocサーバーからGemドキュメントにアクセスするために使用するのが最も便利な場合がよくあります。

または、gemサーバーリストのwwwリンクをたどるか、ファイルを手動で読み取ります。

追加のドキュメントソースは通常doc、通常のRubyツール(rakeやrdoc)を使用して構築されたディレクトリに含まれています。

しかし、あなたが何を求めているのか完全にはわかりません。まず、Javaライブラリには通常APIドキュメントやソースが含まれていません。特に、Mavenを使用している場合は、通常、個別にバンドルされています。Gemsにはソースが含まれているため、RDocはいつでも生成できます。

Javaでは、例は、(a)開発者(IMOが悪用)JavadocをAPIドキュメントに含めるか、(b)例がソースに含まれていて、ソースがある場合にのみ存在します。ダウンロードしたJavaライブラリに「ハウツー」が含まれることはめったにありません。ただし、Mavenを使用して開発され、サイトをパッケージ化し、サイトに通常のAPIレポート以外の使用状況ページが含まれている場合を除きます。

于 2012-09-10T12:28:35.760 に答える