带有 shell 行的 Julia 文档注释（带有 $ 符号）

Question

我尝试在上面写一个文档评论

function main()

像这样

"""
Program arguments:

    $ julia my_julia_program.jl DATE

DATE format should be `yyyymmdd`
"""
function main()

但是，这导致了错误：

ERROR: LoadError: syntax: invalid interpolation syntax: "$ "

我的猜测是 Julia 尝试将此文档注释解释为可运行的示例代码。 （Rust 具有相同的概念 - 可以在文档注释中编写单元测试和示例，然后可以通过

cargo test

运行。）

任何人都可以建议我应该做什么来解决这个问题吗？我想在此处包含

$

符号，以向读者表明该行是应该从 shell 运行的命令行。因此

$

。

Answer 1

需要反斜杠（转义）：

"""
Program arguments:

    \$ julia my_julia_program.jl DATE

DATE format should be `yyyymmdd`
"""
function main()