当前位置: 首页 > 编程笔记 >

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

潘学民
2023-03-14
本文向大家介绍如何在Python中获取文档字符串?,包括了如何在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

 

 类似资料:
  • 问题内容: 如何将(度)字符转换为字符串? 问题答案: 将此行放在源代码的顶部 如果您的编辑器使用其他编码,请替换为utf-8 然后,您可以直接在源代码中包含utf-8字符

  • 问题内容: 有没有一种方法可以在Python中对字符串进行子字符串化,以从第三个字符到字符串末尾获取新的字符串? 也许喜欢吗? 如果离开第二部分意味着“直到最后”,而如果离开第一部分,它是否从头开始? 问题答案: Python称这个概念为“切片”,它不仅适用于字符串,还适用于更多的领域。看看这里的一个全面的介绍。

  • 问题内容: 我有一个Java程序,旨在考虑xml dom并将其写入字符串。我正在使用这些软件包:和 所以我有,,对象… 有没有办法在一个调用中获取代表我的xml dom的字符串? 问题答案: 它不是一个电话,而是: setOutputProperty方法使字符串输出更漂亮,因此可以将其取出。

  • 问题内容: 例如,我得到一个字符串: 我想将其写入文件。 但是在将字符串写入文件之前,我需要知道字符串的大小。我可以使用什么函数来计算字符串的大小? 问题答案: 如果您在谈论字符串的长度,则可以使用: 如果您需要以字节为单位的字符串大小,则需要: 另外,不要调用您的字符串变量。它遮盖了内置功能。

  • 问题内容: 我将提取字符串中包含的所有数字。哪个更适合pur 例: 结果: 问题答案: 如果只想提取正整数,请尝试以下操作: 我认为这比正则表达式示例更好,原因有三点。首先,你不需要其他模块;其次,它更具可读性,因为你无需解析迷你语言;第三,它更快(因此可能更): 这将无法识别浮点数,负整数或十六进制格式的整数。如果你不能接受这些限制,则可以通过以下亭亭玉立的答案解决问题。

  • 我试图解决的用例是: 查找 /apps.下所有组件的所有页面引用 i、 e.首先查找正在使用组件的所有页面,然后对/apps下的所有组件执行此操作。 通过使用Adobe AEM的报表生成器工具:https://adobe-consulting-services.github.io/acs-aem-commons/features/report-builder/configuring.html 查询