在Python中,注释可以出现在以下位置:
- 单行注释 :
-
位置 :位于代码行的开头或中间,以“#”符号开始,直到该行结束。如果需要延续到下一行,可以在下一行也加上“#”并继续写注释。
-
示例 :
# 这是一个单行注释
x = 10 # 定义一个变量x并赋值为10
```
2. **多行注释** :
- **位置** :可以位于代码块的开头,使用三个单引号“'''”或三个双引号“"""”括起来,内容可以跨行书写。
- **示例** <b class="card40_2411__sup_5321" data-sup="sup">2</b>:
```python
'''
这是一个多行注释的示例。
可以包含多行文本
'''
def add(a, b):
return a + b
```
3. **文档字符串(Docstrings)** <b class="card40_2411__sup_5321" data-sup="sup">2</b>:
- **位置** :位于模块、类或函数定义的下方,是该对象的第一个字符串,使用三个双引号“"""”或三个单引号“'''”括起来。
- **示例** <b class="card40_2411__sup_5321" data-sup="sup">2</b>:
```python
def add_numbers(a, b):
"""
该函数用于计算两个数的和。
参数:
a (int): 第一个加数
b (int): 第二个加数
返回值:
int: 两个数的和
"""
return a + b
```
### 建议<b class="card40_2411__sup_5321" data-sup="sup">3</b>
- **清晰简洁** :注释应简洁明了,准确描述代码的功能和目的。
- **位置一致** :养成在代码上部写注释的习惯,这样符合阅读习惯,也便于快速查找和理解代码。
- **文档字符串** :对于函数、类和模块,建议使用文档字符串进行详细说明,以便其他开发者更好地理解和使用。