documentation - 来自Documenter.jl中其他子模块的交叉引用功能

给定类似模块的层次结构

module A
    module B; function foo end; end
    module C
        """
            bar(x)

        Like [`foo`](@ref), but more `bar`.
        """
        function bar end
    end
end

如何使用Documenter.jl从foo的文档字符串交叉引用bar？我尝试A.B.foo，B.foo和..B.foo没有成功。

最佳答案

首先，B.foo和C.bar都需要（i）具有文档字符串，并且（ii）在降价文件中，例如在Documenter @docs block中。

```@docs
A.B.foo
A.C.bar
```

为了他们之间的相互参照。其次，绑定B.foo必须在C模块内部可见。例如，可以通过在import ..B: foo模块中添加C（或在export foo中添加B和在using ..B中添加C）来实现。这是一个工作示例：

module A
    module B
        "foo function"
        function foo end
    end
    module C
        import ..B: foo
        """
            bar(x)

        Like [`foo`](@ref), but more `bar`.
        """
        function bar end
    end
end # module