在Python中,有两种主要的注释方式:
单行注释:
使用``符号。在``符号后面的所有内容都会被Python解释器忽略,直到行尾。例如:
```python
这是一个单行注释
print("Hello, World!") 这也是一个注释,位于代码行的末尾
```
多行注释:
虽然Python没有专门的多行注释语法,但可以通过连续使用单行注释(即多个``符号)或使用三引号(`'''`或`"""`)来模拟多行注释。当三引号内的内容不被赋值给任何变量或不被使用时,它们实际上就起到了多行注释的作用。例如:
```python
'''这是一个多行注释
可以跨越多行
用来对一段代码或者一个函数进行详细的说明'''
def add_numbers(a, b):
return a + b
"""这也是一个多行注释
同样可以跨越多行
作用和上面的单引号多行注释一样"""
def multiply_numbers(a, b):
return a * b
```
此外,Python还支持文档字符串(Docstrings),这是一种特殊的多行注释,用于为函数、类、模块等添加文档说明。文档字符串使用三个双引号(`"""`)或三个单引号(`'''`)包围。例如:
```python
def greet(name):
"""这个函数用于向指定的人打招呼。
:param name: 要打招呼的人的名字,是一个字符串类型。
:return: 返回一个包含问候语的字符串。
"""
return f"Hello, {name}!"
```
总结:
单行注释使用``符号。
多行注释可以使用三引号(`'''`或`"""`)。
文档字符串(Docstrings)也是多行注释的一种,使用三个双引号(`"""`)或三个单引号(`'''`)。