在julia 1.1.0中结合默认和自定义文档字符串吗？

Question

我正在使用Julia v1.1.0，并且对编写文档（文档字符串）有疑问。

我发现构造函数的默认文档非常有用，尤其是字段列表。有没有一种方法可以将默认文档与自定义文档结合在一起，以便我既可以自动获得字段名称列表，又可以得到手动编写的文档字符串？

Answer 1

您可能对软件包DocStringExtensions（documentation）感兴趣，尤其是FIELDS的缩写。示例：

julia> using DocStringExtensions

julia> """
       This is some documentation.

       $(FIELDS)
       """
       struct Struct
           x
           "docs for field y"
           y
       end
Struct

help?> Struct
search: Struct struct isstructtype mutable struct unsafe_trunc

  This is some documentation.

    •    x

    •    y

        docs for field y