跳到主要内容

DocField

类数据类源码

DocField(
name: str,
type: str,
default: str = "",
init_skipped: bool = False,
descr: str = "",
doc: str = ""
)

数据类/模型中,某个字段的 docstring。

字段​

字段类型必选
说明
namestr字段的名称。
typestr字段的类型。该值通常是该字段的类型提示(标注)。
defaultstr字段默认值的格式化结果。
init_skippedbool布尔标记。如果设置了,该字段将被标记为不会出现在初始化中。
descrstr字段的 docstring 文字,只能从源码中提取。
docstr字段额外的动态/运行时 docstring。在渲染文档时,不会用到它。