scala - 记录 Scala 2.10 宏

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。 .

已关闭 5 年前。

Improve this question

我将从一个例子开始。这相当于 List.fill对于 Scala 2.10 中作为宏的元组:

import scala.language.experimental.macros
import scala.reflect.macros.Context

object TupleExample {
  def fill[A](arity: Int)(a: A): Product = macro fill_impl[A]

  def fill_impl[A](c: Context)(arity: c.Expr[Int])(a: c.Expr[A]) = {
    import c.universe._

    arity.tree match {
      case Literal(Constant(n: Int)) if n < 23 => c.Expr(
        Apply(
          Select(Ident("Tuple" + n.toString), "apply"),
          List.fill(n)(a.tree)
        )
      )
      case _ => c.abort(
        c.enclosingPosition,
        "Desired arity must be a compile-time constant less than 23!"
      )
    }
  }
}

我们可以按如下方式使用此方法:

scala> TupleExample.fill(3)("hello")
res0: (String, String, String) = (hello,hello,hello)

这家伙在几个方面都是一只奇怪的鸟。一、arity参数必须是一个文字整数，因为我们需要在编译时使用它。在 Scala 的早期版本中，(据我所知)方法甚至无法判断其参数之一是否是编译时文字。

第二，Product返回类型is a lie —静态返回类型将包括由参数确定的具体数量和元素类型，如上所示。

那么我该如何记录这件事呢？我并不期望 Scaladoc 支持在这一点上，但我希望了解约定或最佳实践(不仅仅是确保编译时错误消息清晰)，这将使运行宏方法 - 及其潜在的奇怪需求——对于 Scala 2.10 库的用户来说并不奇怪。

新宏系统最成熟的演示(例如 ScalaMock 、 Slick 、其他列出的 here )在方法级别仍然相对没有记录。任何示例或指针将不胜感激，包括来自具有类似宏系统的其他语言的示例或指针。

Answer 1

我认为记录这些内容的最佳方法是使用示例代码，正如迈尔斯在他的实验 macro based branch 中所做的那样。无形的。