Documenter.jl如何在markdown中写入函数名的特殊字符？

综合讨论区 库的安装及使用
1

比如我的函数及其注释：

@doc raw"""
    ∇normedVoltage(z, ϕs::Float64, ϕ2s::Float64, r::Float64, h1::Int64, h::Int64, circum::Float64)::Float64

归一化电压的1阶导数。
"""
function ∇normedVoltage(z, ϕs::Float64, ϕ2s::Float64, r::Float64, h1::Int64, h::Int64, circum::Float64)::Float64
    res = cos(ϕs - 2 * h1 * π * z / circum) + r * h * cos(ϕ2s - 2 * h1 * h * π * z / circum)
    -2 * h1 * π / circum * res
end
@doc raw"""
    ∇normedVoltage(z, par::ParDBRF)::Float64

归一化电压的1阶导数。
"""
function ∇normedVoltage(z, par::ParDBRF)::Float64
    ∇normedVoltage(z, par.ϕs, par.ϕ2s, par.r, par.h1, par.h, par.circum)
end

可以看到我函数名有个\nabla字符。
然后我在写包的说明文档时，在docs/src/下的.md文件内写入：

```@docs
∇normedVoltage
```

但是编译时候报错了。

PS F:\Documents\JuliaProgramme\MyModules\DoubleRFs\docs> julia --project .\make.jl
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
┌ Error: undefined binding '∇normedVoltage' in `@docs` block in src\api.md:34-36
│ ```@docs
│ ∇normedVoltage
│ ```
└ @ Documenter C:\Users\16398\.julia\packages\Documenter\qoyeC\src\utilities\utilities.jl:44
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
ERROR: LoadError: `makedocs` encountered an error [:docs_block] -- terminating build before rendering.
Stacktrace:
 [1] error(s::String)
   @ Base .\error.jl:35
 [2] runner(::Type{Documenter.Builder.RenderDocument}, doc::Documenter.Document)
   @ Documenter C:\Users\16398\.julia\packages\Documenter\qoyeC\src\builder_pipeline.jl:253
 [3] dispatch(::Type{Documenter.Builder.DocumentPipeline}, x::Documenter.Document)
   @ Documenter.Selectors C:\Users\16398\.julia\packages\Documenter\qoyeC\src\utilities\Selectors.jl:170
 [4] #86
   @ C:\Users\16398\.julia\packages\Documenter\qoyeC\src\makedocs.jl:248 [inlined]
 [5] withenv(::Documenter.var"#86#88"{Documenter.Document}, ::Pair{String, Nothing}, ::Vararg{Pair{String, Nothing}})
   @ Base .\env.jl:257
 [6] #85
   @ C:\Users\16398\.julia\packages\Documenter\qoyeC\src\makedocs.jl:247 [inlined]
 [7] cd(f::Documenter.var"#85#87"{Documenter.Document}, dir::String)
   @ Base.Filesystem .\file.jl:101
 [8] #makedocs#84
   @ C:\Users\16398\.julia\packages\Documenter\qoyeC\src\makedocs.jl:247 [inlined]
 [9] top-level scope
   @ F:\Documents\JuliaProgramme\MyModules\DoubleRFs\docs\make.jl:6
in expression starting at F:\Documents\JuliaProgramme\MyModules\DoubleRFs\docs\make.jl:6

没有这个特殊字符的函数名都编译通过了。这种没有，不知道怎么办了

2

这个问题，外国论坛也没人理我，我是没想到的。估计难度有点大

3

把能复现错误的代码贴上去，比如你的 make.jl 文件。最好有一个最简的复现示例，别人才能从中排查问题。或者方便的话也可以把仓库贴出来。

单从定义函数和查看帮助，没有显示什么报错：

image
image1736×734 82.1 KB

4

嗐，理解错了。

这个Error: undefined binding '∇normedVoltage' in `@docs` block in src\api.md:34-36的意思是没找到。

不是因为∇字符导致没找到，是因为带∇字符的我刚好没export。

对于没有export的函数，和正常调用包一样，需要用包名称.函数名，它才能找到。

我以为在包里面标记了@doc raw就会自己找过去，无需export呢。

5

除非只有你自己用，不然非常不建议这么写。这样别人每次在调用你的函数时候要多打好多字符。

1 个赞
6

嗯嗯，常用的我都export了。

只是写文档留给学弟学妹什么的，我希望能事无巨细一点。

比如电压的∇梯度，其实只是我求相空间不动点的一个中间函数，所以我觉得没必要export。求不动点我已经写成了现成的函数，那个我export了。