在ruby代码中发现此代码注释样式是什么

Question

我最近打开了一个包含ruby代码的git存储库。 我看到了此代码注释约定-它是什么，做什么 它有文档吗？

  # Test if the current request URL is canonical
  #
  # @return [Boolean]
  #
  # @api private
  def canonical_url?
    request.path == canonical_url
  end

Answer 1

每亩所说的绝对是yardoc。您可以在下面使用的标签上查看文档：

• @api
• @return