如何用Elixir Macro为函数添加文档？遇编译错误求解答

问题根源 #

模块属性（比如@doc）的求值时机是模块编译阶段，且完全基于当前被定义模块的上下文。你在@doc get_doc(:hello)里调用get_doc/1时，当前模块既没定义这个函数，也没导入它，自然会报找不到的错误。而把get_doc(:hello)放到函数内部能运行，是因为函数体内的代码上下文在use宏展开之后，此时get_doc已经被导入（如果你的use宏里做了导入的话）。

你的猜测验证 #

直接用import替换use不是最佳方案，但方向是对的——核心是要让get_doc/1在@doc求值前进入当前模块的上下文：

• 如果你的use只是单纯为了导入get_doc，那换成import YourMacroModule, only: [get_doc: 1]确实能解决问题；
• 但如果use里还有其他宏逻辑（比如你要实现的自动给函数加文档的功能），就不能直接替换，而是要在宏模块的__using__宏里加上导入语句，确保get_doc被导入到使用use的模块中。

正确实现示例 #

宏模块定义

defmodule DocHelper do
  defmacro __using__(_opts) do
    quote do
      # 把get_doc导入到目标模块的上下文里
      import DocHelper, only: [get_doc: 1]
      # 这里可以加你需要的其他宏逻辑，比如自动生成函数文档的代码
    end
  end

  def get_doc(key) do
    # 根据key返回对应的文档内容
    case key do
      :hello -> "这是hello函数的说明文档"
      _ -> "默认函数文档"
    end
  end
end

目标模块使用

defmodule MyModule do
  use DocHelper

  @doc get_doc(:hello)
  def hello, do: :world
end

这样修改后，use宏会先把get_doc/1导入到MyModule中，之后@doc求值时就能找到这个函数，编译错误就会消失。

内容的提问来源于stack exchange，提问作者Marin