julia - 如何使用户定义的函数描述（“文档字符串”）可用于 julia REPL？

Question

当通过fREPL 使用?f或help(f)

例如想象我写了以下功能

function f(x::Float64, y::Float64)
    return 2x - y^2
end

如果我将其加载到 julia 会话中并尝试help(f)得到以下信息：

julia> help(f)
f (generic function with 1 method)

如果我想看到类似的东西怎么办

julia> help(f)
f

   Compute 2 times x minus y squared

其中“计算 2 次 x 减去 y 平方”的描述写在某处。我猜我的问题的答案可以从“描述应该写在哪里？”这个问题的答案中确定。

---

例如，如果我想在 python 中做同样的事情，我可以定义函数并将描述作为文档字符串：

def f(x, y):
    """
    Compute 2 times x minus y squared
    """
    return 2 *  x - y ** 2

help(f)当我键入或f?从 IPython时，这将使我的描述立即可用。

Answer 1

您可以@doc在 Julia 版本 0.4（2015 年 10 月）及更高版本中使用该宏。

% julia
               _
   _       _ _(_)_     |  A fresh approach to technical computing
  (_)     | (_) (_)    |  Documentation: http://docs.julialang.org
   _ _   _| |_  __ _   |  Type "?help" for help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 0.4.0 (2015-10-08 06:20 UTC)
 _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
|__/                   |  x86_64-apple-darwin13.4.0

julia> @doc """
       Compute 2 times x minus y squared.
       """ ->
       function f(x::Float64, y::Float64)
           return 2x - y^2
       end
f (generic function with 1 method)

julia> @doc f
  Compute 2 times x minus y squared.

编辑：正如@Harrison Grodin 所指出的，0.5 及更高版本支持缩写语法以及 Markdown、LaTEX 和其他一些好东西：

"""
Calculate the left Riemann sum[^1] approximating ``\int_a^b f(x) dx = F(b) - F(a).``

[^1]: Thomas G., Finney R. (1996), Calculus and Analytic Geometry, Addison Wesley, ISBN 0-201-53174-7
"""
function rs(a, b, d, f)
end

文档中有更多详细信息。

Answer 2

在 Julia v0.5+（包括更新的 Julia 版本，如 1.2+）中，您可以在函数定义上方编写多行字符串。（不再需要@doc了。）

julia> """
           cube(x)

       Compute the cube of `x`, ``x^3``.

       # Examples
       ```jldoctest
       julia> cube(2)
       8
       ```
       """
       function cube(x)
           x^3
       end
cube

help?> cube
search: Cdouble isexecutable Ac_mul_B Ac_mul_Bc Ac_mul_B! Ac_mul_Bc! cumsum_kbn

  cube(x)

  Compute the cube of x, x^3.

     Examples
    ≡≡≡≡≡≡≡≡≡≡

  julia> cube(2)
  8

有关正确格式化文档字符串的更多信息，请参阅官方Julia 文档。