python中注释使用三个引号 """ 或 '''

简介: 【8月更文挑战第1天】

image.png
在Python中,使用三个单引号 ''' 或者三个双引号 """ 主要不是用来做注释的,而是用来创建多行字符串或文档字符串(docstrings)。这些多行字符串可以跨越多行,并且在程序运行时不会执行。

注释

如果你想要写多行注释,你可以使用井号 # 来逐行注释,或者在一个大的字符串中写你的注释内容。

示例:

# 这是一个单行注释
# 下面是多行注释的例子
# 第一行注释
# 第二行注释
# 第三行注释

文档字符串 (Docstrings)

当你使用三个引号时,你通常是在创建一个文档字符串。文档字符串是用来描述函数、类或模块用途的特殊类型的字符串。

示例:

def example_function(arg1, arg2):
    """
    这是一个文档字符串 (docstring)。
    它用来解释这个函数的作用、参数和返回值等信息。

    参数:
        arg1: 第一个参数
        arg2: 第二个参数

    返回:
        返回 arg1 和 arg2 的和。
    """
    return arg1 + arg2

在这个例子中,example_function 的 docstring 描述了函数的功能、参数和返回值。这样的字符串可以通过函数的 __doc__ 属性来访问。

多行字符串

如果只是想创建一个多行字符串而不是文档字符串,你也可以这样做:

示例:

multi_line_string = """
这是第一行
这是第二行
这是第三行
"""
print(multi_line_string)

这段代码会输出一个包含三行文本的字符串。希望这能帮助你理解Python中的注释和多行字符串的用法!

目录
相关文章
|
23天前
|
Python
Python三引号用法与变量详解
本文详细介绍了Python中三引号(`"""` 或 `'''`)的用法,包括其基本功能、如何在多行字符串中使用变量(如f-string、str.format()和%操作符),以及实际应用示例,帮助读者更好地理解和运用这一强大工具。
43 2
|
2月前
|
Python
【python从入门到精通】-- 第二战:注释和有关量的解释
【python从入门到精通】-- 第二战:注释和有关量的解释
45 0
|
2月前
|
数据采集 前端开发 Python
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
82 0
|
3月前
|
IDE 开发工具 Python
python3代码编程规范(命名、空格、注释、代码布局、编程建议等)
该文章详细介绍了Python3的编程规范,包括命名、空格使用、注释、代码布局等方面的最佳实践,帮助提升代码的可读性和一致性。
55 0
|
4月前
|
Python
python中注释使用连续的单行注释 #
【8月更文挑战第1天】
53 6
|
5月前
|
开发者 Python
Python中注释用途
【7月更文挑战第28天】
63 6
|
5月前
|
开发者 Python
Python 基础语法注释
【7月更文挑战第27天】
81 6
|
4月前
|
IDE API 开发工具
|
5月前
|
语音技术 Python
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式
|
6月前
|
Python
Python Google风格注释详解
Google风格注释是Python代码注释的一种标准化格式,它提供了一种规范的注释格式,使得代码更加易读、易于维护。Google风格注释使用三个双引号来包围注释内容,并按照一定规范编写。在注释中使用动词短语来描述函数的行为,并使用被动语态。在注释中使用正确的标点符号和缩进,使得注释易于阅读和理解。通过使用Google风格注释,我们可以为代码提供清晰的文档和说明,使得代码更加易读、易于维护。
226 3