Python中的__doc__()函数简介与用法

在Python中，__doc__()函数是一个特殊的方法，用于查看一个对象的文档字符串（docstring）。文档字符串是一个对象的 个非空字符串，通常用于描述对象的功能、用法和参数。

__doc__()函数的语法如下：

object.__doc__()

其中，object是要查看文档字符串的对象。该函数返回一个字符串，即对象的文档字符串。如果对象没有文档字符串，则返回None。

下面是一个使用__doc__()函数的例子：

class MyClass:
    """This is a sample class."""
    
    def my_method(self):
        """This is a sample method."""
        pass

obj = MyClass()
print(obj.__doc__())  # 输出: This is a sample class.
print(obj.my_method.__doc__())  # 输出: This is a sample method.

在上面的例子中，我们定义了一个名为MyClass的类，并给它添加了一个文档字符串"This is a sample class."。同样，我们还为类中的my_method()方法添加了文档字符串"This is a sample method."。

然后，我们创建一个MyClass的对象obj，并使用obj.\_\_doc\_\_()函数和obj.my_method.\_\_doc\_\_()函数分别查看了类和方法的文档字符串。

除了使用对象名的方式，我们还可以使用内置的help()函数来查看一个对象的文档字符串，例如：

class MyClass:
    """This is a sample class."""
    
    def my_method(self):
        """This is a sample method."""
        pass

obj = MyClass()
help(obj)  # 输出:
"""
Help on MyClass in module __main__:

class MyClass(builtins.object)
 |  This is a sample class.
 |  
 |  Methods defined here:
 |  
 |  my_method(self)
 |      This is a sample method.
"""

在上面的例子中，我们通过help()函数查看了MyClass的文档字符串。结果显示类的文档字符串"This is a sample class."以及my_method()方法的文档字符串"This is a sample method."。

总之，Python中的__doc__()函数可以用于查看对象的文档字符串，帮助我们了解对象的功能和使用方法。我们可以使用对象名的方式调用该函数，或者直接使用内置的help()函数来查看文档字符串。文档字符串是编写可读性好的代码和自动生成文档的重要组成部分。