Question

这是我的设置：

Ruby 1.9.2 p290
Yard 0.8.1

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

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

问题是院子里没有看到任何文件。

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命令后，我的目录显示了码文件：

.       ..      .yardoc classes doc     run.rb

编辑（对rdoc评论的回应）

一旦我删除了院子创建的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对我的其他红宝石版本不起作用，包括MRI 1.8.7和jRuby 1.6.4。它的行为与上述相同

Answer 1

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

示例 yard classes/*.rb *.rb

Ruby yard doc没有显示任何文件

1 个答案: