【问题标题】:Ruby yard doc not showing any filesRuby yard doc没有显示任何文件
【发布时间】:2012-05-19 12:18:57
【问题描述】:

这是我的设置:

  • Ruby 1.9.2 p290
  • 码 0.8.1

文件夹结构不是 gem,只是普通的旧 Ruby 代码:

.
├── classes
│   ├── crawl.rb
│   └── page.rb
└── run.rb

问题是 yard 没有看到任何文件。

yard doc 产生以下输出:

 Files:           0
 Modules:         0 (    0 undocumented)
 Classes:         0 (    0 undocumented)
 Constants:       0 (    0 undocumented)
 Methods:         0 (    0 undocumented)
 0.00% documented

任何想法为什么它看不到我的任何文件,或者不是


编辑(附加信息):

Yard 确实有权创建文件。

运行yard doc 命令后,我的目录显示了 yard 文件:

.       ..      .yardoc classes doc     run.rb

编辑(回复关于 rdoc 的评论)

一旦我删除了 yard 创建的 doc 文件夹(rdoc 抱怨它)rm -rf doc,rdoc 会生成文档并提供此输出

 Files:       7

 Classes:     6 ( 4 undocumented)
 Modules:     0 ( 0 undocumented)
 Constants:   2 ( 2 undocumented)
 Attributes: 18 (18 undocumented)
 Methods:    24 (20 undocumented)

 Total:      50 (44 undocumented)
  12.00% documented

编辑(附加信息)

Yard 不适用于我的其他 ruby​​ 版本,包括 MRI 1.8.7 和 jRuby 1.6.4。它的行为方式与上述相同

【问题讨论】:

  • 当您发出该命令时,您的工作目录是什么?
  • 工作目录与我的文件所在的目录相同。这与我为上面的示例文件夹结构发出树命令时相同。
  • 当您尝试使用 rdoc 而不是 yard 时会发生什么?这将有助于确定这是完全的院子问题,还是系统/配置问题。
  • rdoc 工作,我编辑了上面的帖子,以便我可以将输出发布在一个长块中。请参阅上面的“编辑(对关于 rdoc 的评论的回复)”

标签: ruby gem rdoc yard


【解决方案1】:

Yard 不会自动记录目录结构中的所有 ruby​​ 文件。它在./lib 目录中查找文件。如果要记录其他人,则必须在命令或 .yardopts 文件中指定

示例 yard classes/*.rb *.rb

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-10-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多