Model.doc文档

property Model.doc

文档字符串

doc 是 Model、Space 和 Cells 的一个属性，用于设置和获取描述该对象的字符串文档。

当通过write_model()或其变体将Model写入文件时，Model的文档字符串以及Model中的UserSpace对象会被写入__init__.py文件的顶部，就像它们是Python模块的文档字符串一样。

Cells的doc属性会链接到其Formula的文档字符串，前提是该Formula不是由lambda函数定义的。 当Cells的doc属性被更新时，其Formula的文档字符串也会同步更新，反之亦然：

>>> foo.formula
def foo(x):
    """The docstring of foo"""
    return x

>>> foo.doc
'The docstring of foo'

>>> foo.doc = "The doc propery of foo"

>>> foo.formula
def foo(x):
    """The doc propery of foo"""
    return x

另请参阅

Cells.set_doc

在0.14.0版本中变更。