ruby代码中的这种代码注释风格是什么

我最近打开了一个包含ruby代码的git存储库。 我看到了这段代码对约定进行了注释-它是什么，它的作用是什么 它有文档吗

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

---

根据穆所说，这绝对是雅多克。您可以在下面使用的标签上查看文档：

检查这里，@ray或Yard：