如何在Python中获取文档字符串？

文档字符串是文档字符串，它是字符串文字，它出现在类，模块，函数或方法定义中，并被写为第一条语句。

Doc字符串有两种类型：

• 单行文档字符串

• 多行文档字符串

这些主要用于DataScience  /机器 学习 编程中。

单行文档字符串

这种类型的Doc字符串适合一行。您可以使用单引号（'...'）或三引号（'''....'''）来编写它们。 

例子1

在下面的程序中，我们在函数中声明一个doc字符串，并打印其内容。

def square(x):
'''Returns argument x is squared.'''
return x**x

print (square.__doc__)
help(square)

输出结果

Returns argument x is squared.
Help on function square in module __main__:

square(x)
Returns argument x is squared.

多行文档字符串

在多行文档字符串类似于 单行文档字符串唯一不同的是，多行文档字符串的第一行后，我们关闭之前离开一个空行，其次是描述性文本。

例子2

def function(arg1):
"""Explanation of the function

Parameters:
arg1 (int): Description of arg1

Returns:
int:Returning value


"""

return arg1

print(function.__doc__)

输出结果

 如您所见，句子“函数的解释”与注释的其他内容之间用一个空白行分隔。

Explanation of the function

Parameters:
arg1 (int): Description of arg1

Returns:
int:Returning value