python两种注释用法的示例

注释

　　标注解释，目的是帮助读者理解的文本
　　也就是说，注释首先是文本，其二是说明，其三是思路，其四是例子

注释有两种形式

1. # ... 单行注释

用于对某句语句或语句块进行解释
放在语句块的头行或一个语句的尾部

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)

2. """ ... """ 多行注释，官方名: 文档字符串 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 注释的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • 浅析Python 引号、注释、字符串

    Python3.6.3    json==2.0.9    win10.0.17134 字符串 1.不可变类型,可迭代对象,有序(可索引.切片) 2. 用引号引起来表示(见 引号) 3.内部 `\` 表示转义,引号前面加 `r` 禁用转义 注释 1.只有`#`后面的真的是注释,不会被解释器运行 1.# 与内容之间至少一个空格 2.注释一般放在被注释代码的上面 3.如果注释用在同行代码结尾,#与代码之间至少空2个空格 2.三引号(三对单/双引号)也被用来当做多行注释(见 引号3.) 引号 1.单双

  • python快速编写单行注释多行注释的方法

    在python代码编写过程中,养成注释的习惯非常有用,可以让自己或别人后续在阅读代码时,轻松理解代码的含义. 如果只是简单的单行注释,可直接用"#"号开头,放于代码前面. 单行注释也可以跟代码同行,放在代码后面,以"#"号开头. 如果是多行注释,可在每行注释前面加"#"号. 多行注释,也可用3个双引号括起来. 多行注释,还可以用3个单引号括起来. 如需将现有的代码注释掉,可先选中需要注释的代码. 再按Ctrl + / ,这样选中的代码行前均会加上

  • Python 中写注释的方法

    在写 Python 代码的时候,一个很好的编码实践就是使得你的代码简洁,易懂.组织代码,设置变量,以及给函数有意义的名字,都是几个不错的方法. 另外一个提高代码可读性的方式就是使用注释.一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解.例如,如果你写了一个复杂的正则表达式,你可以添加一个注释,描述代码做了什么. 在你的 Python 代码中添加注释,在将来你阅读你的代码时,可以节省很多的时间和努力.比如说,你想修改一段你在几个月前或者几年前写的脚本.很可能你不记得为什么你写了一些比较

  • Python爬虫库BeautifulSoup获取对象(标签)名,属性,内容,注释

    一.Tag(标签)对象 1.Tag对象与XML或HTML原生文档中的tag相同. from bs4 import BeautifulSoup soup = BeautifulSoup('<b class="boldest">Extremely bold</b>','lxml') tag = soup.b type(tag) bs4.element.Tag 2.Tag的Name属性 每个tag都有自己的名字,通过.name来获取 tag.name 'b' tag.

  • Python如何脚本过滤文件中的注释

    确保对模块, 函数, 方法和行内注释使用正确的风格,Python中的注释有单行注释和多行注释.如果希望去除文件中所有注释,如何做呢? Python中的注释: Python中单行注释以 # 开头,例如: # 这是一个注释 print("Hello, World!") 多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来,例如: #!/usr/bin/python3 ''' 这是多行注释,用三个单引号 这是多行注释,用三个单引号 这是多行注释,用

  • VSCode中自动为Python文件添加头部注释

    VSCode中自动为Python文件添加头部注释

    在实际编写Python文件时,往往需要为文件添加相关说明,例如文件名称.文件作用.创建时间.作者信息.版本号等等.这些信息往往是固定模板的,因此希望有一种方式可以自动的为我们添加上这些信息.下面介绍一种在VS Code中自动为python文件添加头部注释的方法. 依次单击菜单栏 "File"-"Preferences"-"User Snippets",然后选择python后会生成python.json文件,将该文件内容替换为以下内容: { &qu

  • Python代码注释规范代码实例解析

    一.代码注释介绍 注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码. 注释是编写程序时,写程序的人给一个语句.程序段.函数等的解释或提示,能提高程序代码的可读性. 在有处理逻辑的代码中,源程序有效注释量必须在20%以上. 二.代码注释分类 行注释:在符号后那一行不会被编译(显示) 块注释:被块注释符号中间的部分不会被编译 三.python代码注释基础 Python中使用#表示单行注释.单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后.如下例子: name

  • Python 添加文件注释和函数注释操作

    1.文件添加方式: pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单. #!C:\pythonCode # -*- coding: utf-8 -*- # @Time : ${DATE} ${TIME} # @Author : hlx # @File : ${NAME}.py # @Software: ${PRODUCT_NAME} 2.自动生成函数注释,包括参数和返回值.使用方法,函数定义时,直接输入三个双引

  • python代码如何注释

    注释 注释就是对代码的解释和说明.目的是为了让别人和自己很容易看懂.为了让别人一看就知道这段代码是做什么用的.正确的程序注释一般包括序言性注释和功能性注释.序言性注释的主要内容包括模块的接口.数据的描述和模块的功能.模块的功能性注释的主要内容包括程序段的功能.语句的功能和数据的状态. 注释的分类 1.单行注释 以#开头,#右边的所有东西当做说明,而不是真正要执行的程序,起辅助说明作用 #我是注释,可以在这里写一下功能说明之类 print("我上面一行是对我的注释") 2.多行注释 多行

  • Python之Matplotlib文字与注释的使用方法

    可视化对于大家来说确实是有关的,因为确实是直观的,每一组大数据如果可以用可视化进行展示的话可以让大家豁然开朗.但在另外一些场景中,辅之以少量的文字提示(textual cue)和标签是必不可少的.虽然最基本的注释(annotation)类型可能只是坐标轴标题与图标题,但注释可远远不止这些.让我们可视化一些数据,看看如何通过添加注释来更恰当地表达信息. 首先导入画图需要用到的一些函数: import matplotlib.pyplot as plt import matplotlib as mpl

  • Python中注释（多行注释和单行注释）的用法实例

    前言 学会向程序中添加必要的注释,也是很重要的.注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),在必要时,还可以将代码临时移除,是调试程序的好帮手. 当然,添加注释的最大作用还是提高程序的可读性!很多时候,笔者宁愿自己写一个应用,也不愿意去改进别人的代码,没有合理的注释是一个重要原因.虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相同的思路.或者一段时间以后,你自己也不清楚当时写这段代码的目的了. 总的来说,一旦程序中注释掉某部分内容,

  • Python注释、分支结构、循环结构、伪“选择结构”用法实例分析

    Python注释、分支结构、循环结构、伪“选择结构”用法实例分析

    本文实例讲述了Python注释.分支结构.循环结构.伪"选择结构"用法.分享给大家供大家参考,具体如下: 注释: python使用#作为行注释符,使用三引号作为多行注释符 分支结构: if-else: a=int(input("你的成绩是:")) if a>60: print("你合格了!") else : print("你没及格!") if-elif-else: a = int(input("请输入一个整数&

随机推荐