またはfを使用して REPL を介して検査したときに、ユーザー定義関数 (たとえば) を意味のある出力にするには?fhelp(f)
たとえば、次の関数を書くと想像してください
function f(x::Float64, y::Float64)
return 2x - y^2
end
これをジュリアセッションにロードして試してみるhelp(f)と、次のようになります。
julia> help(f)
f (generic function with 1 method)
代わりに、次のようなものを見たい場合はどうなりますか
julia> help(f)
f
Compute 2 times x minus y squared
「x から y の 2 乗を 2 回計算する」という説明がどこかに書かれています。私の質問への答えは、「説明を書くべき場所はどこですか？」という質問への答えから判断できると思います。
例として、Python で同じことをしたい場合は、関数を定義し、説明を docstring として配置できます。
def f(x, y):
"""
Compute 2 times x minus y squared
"""
return 2 * x - y ** 2
これにより、入力したとき、help(f)またはf?IPython からすぐに説明を利用できるようになります。