Data Structure
Networking
RDBMS
Operating System
Java
MS Excel
iOS
HTML
CSS
Android
Python
C Programming
C++
C#
MongoDB
MySQL
Javascript
PHP
Physics
Chemistry
Biology
Mathematics
English
Economics
Psychology
Social Studies
Fashion Studies
Legal Studies如何在 Python 中获取文档字符串？
文档字符串是字符串文字的文档字符串，它出现在类、模块、函数或方法定义中，并作为第一条语句编写。
有两种类型的文档字符串
- 单行文档字符串
- 多行文档字符串
这些主要用于数据科学 /机器 学习 编程。
单行文档字符串
这种类型的文档字符串适合一行。您可以使用单引号（' ... '）或三引号（'''....'''）编写它们。
示例 1
在以下程序中，我们在函数中声明了一个文档字符串，并打印其内容。
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
更新于： 30-Jul-2019
295 次浏览
广告