Doctests 介绍

当你使用 @doc 记录代码时，你可以提供如下代码示例：

# myproject/lib/my_module.exs

defmodule MyModule do
  @doc """
  Given a number, returns `true` if the number is even, otherwise `false`.

  ## Example
    iex> MyModule.even?(2)
    true
    iex> MyModule.even?(3)
    false
  """
  def even?(number) do
    rem(number, 2) == 0
  end
end

你可以将代码示例作为测试用例添加到你的一个测试套件中：

# myproject/test/doc_test.exs

defmodule DocTest do
  use ExUnit.Case
  doctest MyModule
end

然后，你可以使用 mix test 运行测试。