你能直接定义__doc__吗？

Question

我希望我的文档字符串是一个 f 字符串来放置信息，但是如果我尝试这样做，当您键入 foo.__doc__ 或 help(foo) 时它不会显示，所以我尝试了以下方法：

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

尝试过self.__doc__ = f"""..."""，但还是不行：

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

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

我该如何开始？

Answer 1

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

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"

在 func、MyClass 或 my_method 上调用 help() 将显示您的字符串。