ruby-on-rails - 用于链接到命名空间中的模型的 yardoc 语法是什么？

Question

我在他们的网站上找不到它。

这是我的:

# {Page::Section}

但是当我运行 yardoc generation 时，我得到这个错误:

[warn]: In file `app/controllers/pages_controller.rb':2: Cannot resolve link to Page::Section from text:
[warn]: ...{Page::Section}...

当我转到编写上述文档的 api 页面时，它只显示纯文本，而不是指向该对象页面的链接。

不过我怀疑，上面的错误是因为它从来没有找到这个类:

class Page::Section < ActiveRecord::Base

(但如果我将其更改为 PageSection，则文档呈现得很好)。

可能与yard-rest-plugin的版本有关我正在使用？我不确定

Answer 1

我在使用命名空间 Controller 时遇到了这个问题。我很沮丧，但最终是用户错误。

假设class Inherited::ResourceController < InheritedController

{Inherited::ResourceController#show}会工作，但是 {InheritedController::ResourceController#show}将不会。 (看，我告诉过你这是用户错误)