2

这是我的设置：

  • 红宝石 1.9.2 p290
  • 码 0.8.1

文件夹结构不是宝石，只是简单的旧 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。它的行为方式与上述相同

4

1 回答 1

3

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

例子 yard classes/*.rb *.rb

于 2012-05-19T04:18:57.897 回答