get_field_docstrings

v_1: dict[str, str | None] = get_field_docstrings(model_cls: type[Any], include_dyn_assign: bool = False)

从类的源代码中，捕获每个赋值语句后接的 docstring。

参数

参数类型必选说明

model_cls type[Any] 待分析的类。

参数	类型	必选	说明
`model_cls`	`type[Any]`		待分析的类。
`include_dyn_assign`	`bool`		默认情形下，该方法只会探测以下形式语句后的 docstring： `name: type = value` 如果该标记启用，则也会探测以下形式语句后的 docstring： `name = value`

include_dyn_assign

bool

默认情形下，该方法只会探测以下形式语句后的 docstring：

name: type = value

如果该标记启用，则也会探测以下形式语句后的 docstring：

name = value

参数	类型	说明
`v_1`	`dict[str, str \| None]`	各字段的 docstring。如果某个关键字对应的值是`None`，则表明对应的字段没有配置 docstring。