Python注释的两种形式：单行与文档字符串详解

Python注释概述

注释

注释是用于辅助读者理解的文本说明。它首先具备文本属性，其次起到说明作用，第三层含义是展示思路，第四层则是提供示例。

在Python中，注释主要存在两种形式。

单行注释的使用

第一种是#开头的单行注释。

这种注释通常用于对特定语句或代码块进行解释说明。其放置位置灵活，可以位于代码块的首行，也可以紧跟在某个语句的尾部。

def see_seq(iterable):
 
  # 序列开始的下标为 0，也就是索引为 0
  # 序列第一个元素的下标是0，也就是第n个元素的下标为 len(iterable) - 1
 
  # for 循环自动处理索引、索引边界
  # 自动依次取出 0 到 len(iterable)-1 索引对应的值
  # 是不是很简洁？
  for item in iterable:
    print(item)
 
  # 打印分隔符
  print("等价for语句".center(20, "-"))
  # for 循环的原理是
  # 1. 把序列变成一个迭代器，然后保存在一个内部临时变量中 temp_var = iter(iterable)
  # 2. 通过内置函数next()调用迭代器中的 __next__方法获取下一个数据 item = next(temp_var)
  # 3. 到了边界，迭代器会触发一个迭代器耗尽异常，for循环会自动捕获，终止for循环<br>
  # 等价语句
  temp_var = iter(iterable) # 把序列变成一个迭代器
  while True:
    try:
      item = next(temp_var) # next()调用迭代器
    except StopIteration: # 迭代器耗尽异常，推出循环
      break
 
    # 以上是for循环自动完成，这一行才是循环体
    print(item)
 
 
if __name__ == "__main__":
  # 初始列表
  nums = [17, 71, 93, 69, 79, 14, 33, 7, 64, 58, 77, 75, 98, 61, 39, 50, 1, 69, 60, 20]
  names = ["北门吹雪", "小一", "王五", "李四", "张三", "王二"]
 
  # 调用函数，通过索引方式遍历序列
  see_seq(nums)
  see_seq(names)

文档字符串（多行注释）规范

第二种形式是使用三个双引号"""包裹的多行注释，官方称之为文档字符串（docstring）。

文档字符串主要用于解释模块、类或函数的功能与作用方法。按照规范，它应放置在模块、类或函数体的第一行语句位置。

"""
对循环本质的刨析
"""
 
 
class Person(object):
  """人的类"""
   
  def __init__(self, name, age):
    self._name = name
    self.__age = age
 
  @property
  def name(self):
    """获取人的名字"""
    return self._name
 
 
def see_seq(iterable):
  """对比for循环，利用while循环说明for循环的本质"""
 
  for item in iterable:
    print(item)
 
  print("等价for语句".center(20, "-"))
 
  temp_var = iter(iterable)
  while True:
    try:
      item = next(temp_var)
    except StopIteration:
      break
 
    print(item)
 
 
if __name__ == "__main__":
  """测试逻辑，以入口文件则 __name__ 改写为 __main__"""
 
  nums = [17, 71, 93, 69, 79, 14, 33, 7, 64, 58, 77, 75, 98, 61, 39, 50, 1, 69, 60, 20]
  names = ["北门吹雪", "小一", "王五", "李四", "张三", "王二"]
 
  see_seq(nums)
  see_seq(names)

需要注意的是，注释内容不会被Python解释器执行，解释器会直接忽略它们。因此，注释之后不应再编写需要执行的语句逻辑。

以上即为Python两种注释用法的详细说明，如需了解更多关于Python注释的资料，建议关注本站其他相关文章。