2010-11-18 34 views
3

私はクラス内でRDocコメントを使用して記述したいくつかのレーキタスクを文書化しようとしており、角括弧を表す問題にぶち当たっています。私はrakeタスクをパラメータで実行する方法のいくつかの例を追加したいので、rdoc行を次のようにしてください:RDocで角括弧([])をどのように表現できますか?

rake build[MyProject]

問題は、RDocパーサー変換が大括弧を印刷する代わりにリンクを作成することです。私はあらゆる種類のエスケープシーケンスを試しました。 [[; #{[私のプロジェクト]} ; [ MyProject ]何も動作していないようです。

これらの角括弧をエスケープしてリンクに変換できない方法はありますか?私はそれを行うための方法を発見し、さらに実験と

おかげで、 アーロン

答えて

2

まあ。各行の前に2つのスペースを入れると、RDocは行をあらかじめフォーマットされたテキストとして扱い、括弧を描画します。私のために十分に良い。

結果のRDocラインは次のとおりです。

 
# eg. rake build[MyProject] 
+0

コーディングサンプルを表示しているため、インデントが正しいです。インデントされ、固定幅フォントで表示される必要があります。 –

+0

この質問に対するあなたの答えを受け入れてください。そうすれば、SOのインターフェースで答えられたと表示されます。 –

0

時にはソリューションは簡単です。

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] - 溶液でテキストを作成したい場合は、あなたが<em>...</em>バリアント(ないアンダースコアバリアント_..._)を使用する必要があります。

1

<tt>タグは、リンクテキスト[ハイパーリンク]構文をエスケープします(また、テキストをモノスペースフォントで入力します)。

例:

だから、このRDOC

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

は、このドキュメントを生成します。 rake build[MyProject]

関連する問題