Ruby yard 0.7.3无法在降价和纺织方面构建我的自述文件

我已经决定将我的一个项目中的自述文件转换为markdown，并一直在使用yard verify来验证渲染出来的文档。因此，我安装了RDiScont，将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'

---

如果我尝试使用纺织品，也会发生同样的事情。如果有人想重现这个问题，这个项目就开始了。谢谢。

我想你只是对

码

选项感到困惑。帮助说明如下：

$ 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

解释为某种源文件。您的

README.md

将被解释为Ruby源文件（它不是），这将导致如下Ruby错误：

unexpected tinteger, expecting $end

如果您稍微编辑一下

README.md

，您会看到错误的位置在移动，但是如果您尝试将

README.md

作为Ruby源文件读取，则错误是有意义的

---

当运行

yard

时，您不需要说任何关于

README.md

的内容，

yard

将知道如何处理

README.md

本身。

tymu，显然我没有阅读帮助的顶部

yard doc-README.md

成功了。