Elixir 自定义任务未显示在“混合帮助”中

Question

Is the following code not enough to list a custom task on mix help ?

defmodule Mix.Tasks.Start do
  use Mix.Task

  @shortdoc "Starts [App]"
  def run(_) do
    IO.puts("Starting [App]...")
  end
end

I thought that the decorator @shortdoc was enough to list my custom task on mix help but I recompile my code and my custom task is not being listed on mix help .

Answer 1

In trying it out myself I had to add both a @moduledoc and a @shortdoc . Then I had to run mix compile to get the task on the list in mix help .