23

Railsアプリのドキュメント化にYARDを使い始めたところです。特定のマークアップハンドラーを指定しませんでしたが、 `code`がに変換されることを期待していましたcodeが、これは発生しないようです。これは正常な動作ですか？これを機能させるには、いくつかのオプションを追加する必要がありますか？ありがとうございました。

4

3 に答える 3

21

構文はマークダウンとは少し異なります（マークダウンとrdoc）と思います。使用'+'作品。+code+ は<code>ブロックでレンダリングされます。

于 2012-07-27T06:33:47.623 に答える
19

GitHub では、インライン コードのコメントにバッククォートを使用していました。そのため、いくつかの調査の結果、次の非常に優れた解決策を見つけました。

  • redcarpetGemfileに gem を追加する
  • bundleコマンドを実行
  • ファイル--markup=markdownに追加.yardopts
  • を使用してYARDサーバーを起動しますyard server --reload
  • ブラウザで localhost:8808 を開きます

GitHub のような Syntax を使用できるようになりました。

```ruby
def bla; puts 'bla'; end
```

または

`this is inline code`

良い！:)

于 2012-07-27T09:44:32.043 に答える
9

マークダウンがない場合、YARD はインデントされた行のコード ブロックを表示します。

  # This is a useful POSIX regex:
  #   [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}

インデントのスペースは 2 つあれば十分のようです。

于 2014-08-15T00:57:16.017 に答える