通过编程生成的功能，如何定义DOC？

Question

我想按照但是有一些文档。

最小可复制的例子：

julia> cases = ( :A => 1, :B => 2 )
(:A => 1, :B => 2)

julia> for (name,value) in cases
           func_name = Symbol("foo_"*string(name))
           eval(quote
                    $func_name() = $value
                end)
       end

julia> foo_A()
1

julia> foo_B()
2

我的问题是我还想定义一些相关的文档：

help?> foo_A
search: foo_A foo_B unsafe_pointer_to_objref

  No documentation found.

  foo_A is a Function.

  # 1 method for generic function "foo_A":
  [1] foo_A() in Main at REPL[2]:4

我可以做：

for (name,value) in cases
    func_name = Symbol("foo_"*string(name))
    eval(quote
             " The function doc is here "
             $func_name() = $value
         end)
end

在这种情况下：

help?> foo_A()
  The function doc is here

但是我真正需要的是某种替代：

julia> for (name,value) in cases
           func_name = Symbol("foo_"*string(name))
           eval(quote
                    " The function $name returns $value"
                    $func_name() = $value
                end)
       end
ERROR: UndefVarError: name not defined

是否可以 ？

Answer 1

使用 @doc 宏：

for (name,value) in cases
    func_name = Symbol("foo_"*string(name))
    docstr = " The function $name returns $value"
    eval(quote
        @doc $docstr $func_name() = $value
    end)
end

现在哟可以按预期做：

julia> foo_A(), foo_B()
(1, 2)

help?> foo_A
search: foo_A foo_B unsafe_pointer_to_objref

  The function A returns 1

help?> foo_B
search: foo_B unsafe_pointer_to_objref foo_A

  The function B returns 2