juliaのDocumentationについて
code:documentation.jl
"""
ここが do_something のDocumentation
"""
function do_something()
# do something
end
help?> do_something # もしくは @doc do_something
ここが do_something のDocumentation
というような感じになる
julia> (@doc do_something) |> typeof
Markdown.MD
Documentationの型は Markdown.MDである。
code:Markdown.MD.jl
help?> Markdown.MD
No documentation found.
Summary
≡≡≡≡≡≡≡≡≡
mutable struct Markdown.MD <: Any
Fields
≡≡≡≡≡≡≡≡
content :: Array{Any,1}
meta :: Dict{Any,Any}
contentとmetaがあるらしい
Stringを得たいのであれば
Markdown.plainを使う
Markdown.MD.content |> joinする
Markdown.MD.meta |> joinする
julia> (@doc do_something) |> Markdown.plain |> typeof
String
code:color.jl
struct Colors
color_code::String
end
@doc color
code:sigmoid.jl
"""
ς(x, α=1)
sigmoid function
# Expression
\\varsigma_\\alpha(x) = \\frac{\\tanh(\\alpha x/2)+1}{2}
"""
ς(x, α=1) = (tanh(α*x/2)+1)/2
https://gyazo.com/5f973ea4f93e3cf0476a215cdbbcd1e7