这是我的设置:

  • 红宝石1.9.2p290
  • 院子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构建(包括MRI1.8.7和jRuby1.6.4)上不适用于我。它的行为与上述相同

有帮助吗?

解决方案

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

例子: yard classes/*.rb *.rb

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top