使用 Documenter.jl 添加函数文档字符串
Add function docstrings with Documenter.jl
我正在尝试使用 Documenter.jl
为 Julia 包创建文档。 (虽然我对 Julia 还很陌生。)现在我想知道如何让所有带有文档字符串的函数出现在文档中?我知道我可以通过
添加函数 f
## Functions
```@docs
f
```
在降价文件中,但这意味着我必须手动添加所有功能。有没有自动添加所有功能的方法?
好的,对于任何感兴趣的人,我刚刚发现了如何去做:
```@autodocs
Modules = [Foo, Bar]
Order = [:function, :type]
```
如图https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@docs-block.
我正在尝试使用 Documenter.jl
为 Julia 包创建文档。 (虽然我对 Julia 还很陌生。)现在我想知道如何让所有带有文档字符串的函数出现在文档中?我知道我可以通过
f
## Functions
```@docs
f
```
在降价文件中,但这意味着我必须手动添加所有功能。有没有自动添加所有功能的方法?
好的,对于任何感兴趣的人,我刚刚发现了如何去做:
```@autodocs
Modules = [Foo, Bar]
Order = [:function, :type]
```
如图https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@docs-block.