如何對 mix.exs 中定義的別名進行描述？

Question

當我在mix.exs定義別名並運行mix help ，它只會將其描述顯示為“在 mix.exs 中定義的別名”。

例如，假設我有這個mix.exs ：

  defp aliases do
    [
      play: "run --no-halt"
    ]
  end

然后， mix help命令顯示如下任務列表：

...
mix local.rebar       # Installs Rebar locally
mix new               # Creates a new Elixir project
mix play              # Alias defined in mix.exs
mix profile.cprof     # Profiles the given file or expression with cprof
mix profile.eprof     # Profiles the given file or expression with eprof
...

如何描述play任務？

Answer 1

mix help的輸出來自自定義混合任務中的@shortdoc屬性

defmodule Mix.Tasks.Play do
  use Mix.Task
  @shortdoc "run with --no-halt"

  @impl Mix.Task
  def run(_) do
    Mix.Task.run("run", ["--no-halt"])
  end
end

mix help | grep "mix play"
mix play                  # run with --no-halt

我認為沒有辦法為別名添加幫助文檔。