Elixir是一种函数式编程语言,通常使用ExUnit作为测试框架来进行代码测试,使用ExDoc来生成文档。
首先,在项目根目录创建一个名为test
的文件夹,用于存放测试代码。
在mix.exs
文件中,添加{:ex_unit, "~> x.x.x"}
依赖,并在:test
应用中添加:ex_unit
。
defp deps do
[
{:ex_unit, "~> x.x.x"}
]
end
def application do
[
extra_applications: [:logger, :ex_unit]
]
end
创建测试文件,通常以_test.exs
为后缀,例如my_module_test.exs
。
在测试文件中使用ExUnit提供的宏来编写测试用例,例如:
defmodule MyModuleTest do
use ExUnit.Case
test "addition" do
assert MyModule.add(1, 2) == 3
end
end
mix test
命令来执行测试。mix.exs
文件中,添加{:ex_doc, "~> x.x.x"}
依赖,并在:docs
应用中添加:ex_doc
。defp deps do
[
{:ex_doc, "~> x.x.x"}
]
end
def application do
[
extra_applications: [:logger, :ex_doc]
]
end
运行mix docs
命令生成文档,文档会生成在doc
文件夹中。
你也可以在mix.exs
中配置文档生成的选项,例如指定要生成文档的模块、排除某些模块等。
def project do
[
docs: [
main: "MyModule",
source: ["lib"],
skip: ["MyModule.Utils"]
]
]
end
通过以上步骤,你可以在Elixir项目中实现代码测试和文档生成。