4

私のプロジェクトのREADMEファイルをマークダウンに変換することにしました。そして、ヤードを使用して、ドキュメントが正常にレンダリングされたことを確認しました。そこで、rdiscountをインストールし、READMEをREADME.mdに変更して、次のことを試しました。

yard doc README.md

それは私に警告を与えました：

[warn]: Syntax error in `readme.md`:(3,18): syntax error, unexpected tinteger, expecting $end

だから私は試しました：

yard doc -m markdown -- README.md

同じ問題。ランニング：

yard doc --backtrace -- README.md

もう少し情報を提供します：

[warn]: Syntax error in `readme.md`:(3,18): syntax error, unexpected tinteger, expecting $end
[error]: ParserSyntaxError: syntax error in `README.md`:(3,18): syntax error, unexpected tINTEGER, expecting $end
[error]: Stack trace:
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:505:in `on_parse_error'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:15:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/source_parser.rb:438:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/source_parser.rb:361:in `parse_in_order'

テキスタイルを使ってみても同じことが起こります。誰かが問題を再現してみたい場合は、プロジェクトはgithubにあります。ありがとうございました。

4

1 に答える 1

6

オプションについて混乱しているだけだと思いyardます。ヘルプには次のように書かれています。

$ yard --help doc
Usage: yard doc [options] [source_files [- extra_files]]
(if a list of source files is omitted, 
  {lib,app}/**/*.rb ext/**/*.c is used.)

Example: yardoc -o documentation/ - FAQ LICENSE
  The above example outputs documentation for files in
  lib/**/*.rb to documentation/ including the extra files
  FAQ and LICENSE.
...

だからあなたがこれを言うとき：

$ yard doc -m markdown -- README.md

Yard はREADME.md何らかのソースファイルとして解釈しようとします。RubyREADME.mdソース ファイル (そうではない) として解釈され、次のようなRubyエラーが発生します。

unexpected tinteger, expecting $end

少し編集するREADME.mdと、エラーの場所が移動するのがわかりますがREADME.md、Ruby ソース ファイルとして読み込もうとすると、エラーが意味を成します。

README.md実行yard中は何も言う必要はありません。それ自体yardで何をすべきかがわかります。README.md

于 2011-10-26T20:19:37.983 に答える