Python3注释规范与实现详解

Felix
Felix
发布时间:2026-10-13 | 6人浏览过
原创

本文详解Python3中的注释规范,涵盖单行以#开头的写法,以及使用三个单引号或双引号实现的多行注释。同时介绍如何通过__doc__属性获取函数的文档字符串,帮助开发者遵循正确的代码风格。

Python3 注释

确保对模块, 函数, 方法和行内注释使用正确的风格

Python中的注释有单行注释和多行注释:

Python中单行注释以 # 开头,例如::

# 这是一个注释
print("Hello, World!") 

多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来,例如:

1、单引号(''')

#!/usr/bin/python3 
'''
这是多行注释,用三个单引号
这是多行注释,用三个单引号 
这是多行注释,用三个单引号
'''
print("Hello, World!") 

2、双引号(""")

#!/usr/bin/python3 
"""
这是多行注释,用三个双引号
这是多行注释,用三个双引号 
这是多行注释,用三个双引号
"""
print("Hello, World!") 

读者笔记

以下实例我们可以输出函数的注释:

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

输出结果为:

这是文档字符串

本站声明

本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。

Python 相关产品和应用

全部下载

专题列表