Question

当我试图创建我的rails控制器的文档和所使用的参数时，我因为院子似乎期望而卡住了，参数作为方法参数存在。

# Renders a list of items
# @param params [Hash] the search parameters
# @option params [String] 'info' Only return items with this specific info
# @option params [Integer] 'limit' Only return <limit> items
def index
  # ... do something smart here
end

因此，对于此文档，会发出警告并且不会创建文档：

[warn]: @param tag has unknown parameter name: params 
in file `app/controllers/items_controller.rb' near line 8

有没有办法使用码头记录这些类型的物品，还是我需要手动执行此操作？

Answer 1

我不知道通过Yard记录动作参数的Rails约定。如果有人知道更多的话，将非常乐意了解一个。

Yard非常灵活。例如，您可以为项目define your own tags。添加专用于记录控制器操作参数的标记。

首先在Yard选项文件.yardopts中包含标记定义。该文件从项目的根目录中获取：

--type-name-tag controller_action_param:"Controller Action Parameters"

在控制器操作中使用新标记，如下例所示：

# Renders a list of items
# @controller_action_param :info [String] Only return items with this specific info
# @controller_action_param :limit [Integer] Only return <limit> items
def index
  # ... do something smart here
end

您现在定义的约定是参数名称是用于访问参数数据的键 - 例如params [：info]。

定义最适合您的标签名称和标题文本 - 这只是一个示例。

使用码的Rails控制器的文档

1 个答案: