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項目中實現代碼測試和文檔生成。