Python代码注释规范：单行与多行写法详解

Python注释概述

注释

注释是对代码的解释与说明，旨在提升代码的可读性，使他人或自己能快速理解代码用途。规范的程序注释通常包含序言性注释和功能性注释两部分。序言性注释主要描述模块接口、数据定义及模块整体功能；功能性注释则针对具体代码段，说明语句功能及数据状态。

注释类型详解

注释的分类

单行注释写法

1.单行注释

Python中使用井号（#）作为单行注释的起始符号。#右侧的所有内容均被视为说明文字，而非执行代码，起到辅助说明的作用。

#我是注释，可以在这里写一下功能说明之类

print("我上面一行是对我的注释")

多行注释写法

2.多行注释

Python中实现多行注释可使用三对双引号（"""）或三对单引号（'''）。需注意，必须使用相同类型的引号，即要么全用双引号，要么全用单引号，不可混合使用。

"""

　　我是多行注释1

　　我是多行注释2

　　我是多行注释3

"""
print("我上面的是多行注释")

内容补充：

查看函数文档字符串

以下实例展示了如何输出函数的注释（文档字符串）：

def a():
 '''这是文档字符串'''
 pass
print(a.__doc__)

到此这篇关于python代码如何注释的文章就介绍到这了,更多相关python是如何注释的内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站！