DocProp

类数据类源码

DocProp(name: str, descr: str, type: str)

类属性的 docstring 和其他基本信息。

类属性可以由@property或者@functools.cached_property定义。

字段

字段	类型	必选	说明
name	str		属性的名字。
descr	str		属性的描述文字。
type	str		属性的类型。该值通常是该属性的类型提示（标注）。

方法

as_md_text

v_1: str = self.as_md_text(renderer: ProtocolComponent)

渲染成 Markdown 文字。

输入

参数	类型	必选	说明
renderer	ProtocolComponent		用来渲染组件的渲染器。

输出

参数	类型	说明
v_1	str	从类的属性中渲染的 Markdown 文本。

属性

str_v2

str_v2: str = self.str_v2

渲染 V2 字符串。

所谓 v2 字符串可以描述为以下格式：

prop_name: type = self.prop_name

相比默认的字符串格式更加紧凑。