f
通过REPL使用?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输入文字时,这些说明将立即可用。