4

クラスで RDoc コメントを使用して記述したいくつかの rake タスクを文書化しようとしていますが、角かっこを表す際に問題が発生しています。パラメータを指定して rake タスクを実行する方法の例をいくつか追加したいので、次のような rdoc 行を作成します。

＃例。rake build[MyProject]

問題は、RDoc パーサー convert が角かっこを出力する代わりにリンクを作成することです。私はあらゆる種類のエスケープ シーケンスを試しました。[[; ＃{[私のプロジェクト]} ; [マイプロジェクト] しかし、何も機能していないようです。

リンクに変換されないように、これらの角括弧をエスケープする方法はありますか?

ありがとう、アーロン

4

3 に答える 3

3

さらなる実験で、私はそれを行う方法を発見しました。各行の前に 2 つのスペースを入れると、RDoc はその行を書式設定済みのテキストとして扱い、括弧をレンダリングします。私には十分です。

結果の RDoc 行は次のとおりです。

＃例。rake build[MyProject]
于 2010-11-18T12:52:53.380 に答える
2

タグは<tt>link-text[hyperlink] 構文をエスケープします (また、テキストをモノスペース フォントにします)。

したがって、このrdoc

# eg. <tt>rake build[MyProject]</tt>

次のドキュメントが作成されます。

例えば。rake build[MyProject]

于 2015-09-13T15:43:47.057 に答える
1

解決策が簡単な場合もあります。

次のようなコードは、par へのリンクを含むテキストtext[par]を作成します。ただし、間にスペースを入れると、角かっこと同等になります。text[par]

[] を使用したさまざまなバージョンの概要:

* [par] labeled list
* x[par] x is linked with par
* x [par] Text as is (space between x and par)
* []  brackets disapear
* x _[par]_  Content between[] disapears.

text<space>[par]斜体の -solution を使用してテキストを作成する場合は、<em>...</em>バリアント (アンダースコアバリアントではなく_..._) を使用する必要があります。

于 2012-08-03T19:26:55.370 に答える