RDOCの四角いブラケット（[]）を表現するにはどうすればよいですか？

StackOverflow https://stackoverflow.com/questions/4214726

  •  26-09-2019
  •  | 
  •  

質問

私はクラスでRDOCコメントを使用して書いたいくつかのレーキタスクを文書化しようとしており、四角い括弧を表すトラブルに遭遇しています。パラメーターを使用してレーキタスクを実行する方法の例をいくつか追加したいので、次のようなRDOCラインがあります。

＃例えば。 rake build[MyProject]

問題は、RDOCパーサーのコンバージョンが正方形のブラケットを印刷する代わりにリンクを作成することです。私はあらゆる種類のエスケープシーケンスを試しました：[; [[; ＃{[私のプロジェクト]} ; [myproject]しかし、何も機能しないようです。

これらの正方形の括弧を逃れるために、リンクに変換されない方法はありますか？

ありがとう、アーロン

役に立ちましたか？

解決

さらなる実験で、私はそれを行う方法を発見しました。各ラインの前に2つのスペースを置くと、RDOCはラインを事前にフォーマットされたテキストとして扱い、ブラケットをレンダリングします。私にとっては十分です。

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

#  eg. rake build[MyProject]

他のヒント

<tt> タグは、リンクテキスト[HyperLink]構文から逃げます（また、テキストをMonospaceフォントに入れます）。

だからこのrdoc

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

このドキュメントを作成します：

例えば。 rake build[MyProject]

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

のようなコード 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> バリアント（アンダースコアバリアントではありません _..._).

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top