文档带有灰色突出显示的一些文本

时间:2019-03-30 17:23:10

标签: jupyter-notebook julia code-documentation

在Julia中记录函数的选项很简单,这很受欢迎。使用Jupyter笔记本时可以在文档中突出显示某些关键字吗?

例如

"""
function ph(phoenix_one, phoenix-two)

      phoenix_one is an array of tuples containing information on height and weight, and phoenix-two contains position data.
"""
function ph(phoenix_one, phoenix-two)
    return phoenix_one + phoenix-two
end

调用?ph

期望是:

phoenix_one是一个元组数组,其中包含有关身高和体重的信息,而phoenix-two包含位置数据。

代替

phoenix_one是一个元组数组,其中包含有关身高和体重的信息,而phoenix-two则包含位置数据。

突出显示了一些关键字。

1 个答案:

答案 0 :(得分:1)

这是执行此操作的方法(使用反引号+注意文档字符串的布局)

"""
    ph(phoenix_one, phoenix_two)

`phoenix_one` is an array of tuples containing information on height and weight,
and phoenix-two contains position data.
"""
function ph(phoenix_one, phoenix_two)
    return phoenix_one + phoenix_two
end

enter image description here