ruby – yard 0.7.3无法在markdown和textile中构建自述文件

发布时间：2020-12-17 03:01:32 所属栏目：百科来源：网络整理

导读：我已经决定将我的项目中的README文件转换为markdown,并且已经使用了院子验证了所提供的文档.所以我安装了rdiscount,将README更改为README.md并尝试： yard doc README.md 这给了我一个警告： [warn]: Syntax error in `readme.md`:(3,18): syntax error,unex

我已经决定将我的项目中的README文件转换为markdown,并且已经使用了院子验证了所提供的文档.所以我安装了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,expecting $end
[error]: ParserSyntaxError: syntax error in `README.md`:(3,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.谢谢.

解决方法

我觉得你只是对院子选择感到困惑.帮助说：

$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源文件,则错误将有意义.

你根本不需要说任何关于README.md的东西,院子会知道如何处理README.md.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!