elixir - Elixir 中的 `@type t::%__MODULE__{}` 是什么意思

Question

在 std Elixir 包中有很多行，例如

@type t :: %__MODULE__{}

我知道 @type注释用于给 @spec 中类型的短符号起别名注释，但此行用于模块，如 uri.ex没有 @spec注释。

这个注释的目的是什么？

Answer 1

首先，使用 @type 指定的类型指令是 公众 默认情况下(与 @typep 定义的类型相反)。这意味着即使模块中没有规范，定义类型也允许其他开发人员在编写函数时使用该类型:

@doc "Computes the length of a URI."
@spec foo(URI.t) :: non_neg_integer
def foo(uri), do: # ...

__MODULE__是一种特殊形式，它以原子形式扩展为当前模块名称(参见 docs for it)，因此:

defmodule MyModule do
  @type t :: %__MODULE__{}
end

将定义一个 MyModule.t类型。 t 的最常见用法type 用于表示结构和协议(protocol)(例如， Enum.t)。这种模式非常常见:

defmodule User do
  defstruct [:name, :email]
  @type t :: %__MODULE__{name: String.t, email: String.t}
end