Question

我想在rubydoc中用参数或变量或@return声明具有确切对象类的对象数组。（必须是RDoc？..）

主要原因是使RubyMine（或其他IDE）以正确的方式工作于自动完成的东西，可点击的方法，重构等。

在PHP中将如下所示：

/**
 * @param array $items
 * @param Filter[] $filters
 * @return Result[]
 */
function filter($items, $filters) {}

我只是不确定它是否可以在RubyMine中以类似方式工作：

##
# @param [Array] items
# @param [Filter[]] filters
# @return [ResultClass[]]
#
def filter(items, filters); end

PHP中的其他示例：

class My
{
    public $name;
}

/**
 * @return My[]
 */
function foo()
{
      // Similar code here
      //return [new My(), new My()];
}

function show()
{
    foreach (foo() as $item) {
        // IDE will make autocomplete for My::$name
        echo "$item->name\n";
    }
}

Answer 1

class TheClass
  # @param items   [Array]
  # @param filters [Array<Filter>]
  # @return        [Array<TheClass>]
  def filter(items, filters); end
end

如YARD Tags所述。

如何在ruby documentor中声明特定类型的数组？

1 个答案: