Python中常见的注释代码包括:
单行注释:
使用``符号开始,直到行尾。
这是一个单行注释
print("Hello, World!") 这是在代码行后面的单行注释
多行注释:
使用三个单引号`'''`或三个双引号`"""`将注释括起来。
'''
这是一个多行注释
可以在这里添加更多的解释和说明
'''
def add(a, b):
'''
这是一个函数的文档字符串
该函数用于将两个数相加并返回结果
'''
return a + b
文档字符串 (docstrings):用于函数、类或模块的开头,提供文档说明。
def greet(name):
"""
打印问候语
参数:
name -- 要问候的人的名字
返回值:
无返回值
"""
print(f"Hello, {name}!")
文件注释:
在文件开头使用多行注释,提供文件相关信息。
这是一个文件注释
告诉文件的相关信息
TODO注释:
TODO: 完成这个功能
编码声明:
在文件开头指定文件的编码格式,如UTF-8。
-*- coding:utf-8 -*-
这些注释方法有助于提高代码的可读性和可维护性