python - 你可以直接定义 __doc__ 吗？

Question

我希望我的 docstring 是一个 f-string 来放置信息，但是如果我尝试这样做，当你输入foo.__doc__or时它不会显示help(foo)，所以我尝试了以下操作：

使用.format()未注册为文档字符串的

试图做self.__doc__ = f"""..."""，但它仍然没有工作：

def foo():
    self.__doc__ = f"""foo() is a function."""
    pass

我在一个网站上读到，可以定义文档字符串而不只是在开头放置一个文档字符串，但它没有说明如何。

我该如何开始？

标签： pythondocstringf-string

Answer 1

__doc__只是一个属性。您可以在定义类/函数/方法后定义它：

def func():
    pass

func.__doc__ = f"My function doc using fstring"

class Myclass:

    def my_method():
        pass

    my_method.__doc__ = f"My method doc using string"

Myclass.__doc__ = f"My class doc using fstring"

调用help()其中一个func，MyClass或my_method将显示您的字符串。