Python基础之注释的用法

2024-08-02 02:06:47

前言

Python代码的基本规范如下：

1、Python 文件将以 .py 为扩展名。

2、在Python中严格区分大小写（大小写敏感），如果写错了大小写，程序会报错。

3、Python中的每一行就是一条语句，每条语句以换行结束，不用;分号结束。

4、Python是缩进严格的语言，所以在Python中不要随便写缩进。

缩进的好处是强迫你写出缩进较少的代码，你会倾向于把一段很长的代码拆分成若干函数，从而得到缩进较少的代码。
缩进的坏处就是复制－粘贴功能失效了，当你重构代码时，粘贴过去的代码必须重新检查缩进是否正确。

5、一条语句可以分多行编写，多行编写时语句后边以\结尾。

6、Python中每一行语句不要过长（规范中建议每行不要超过80个字符）。

扩展：

Python中文文档地址：https://docs.python.org/zh-cn/3/index.html。关于代码规范：
Python 官方提供有一系列 PEP（Python Enhancement Proposals）文档，其中第 8 篇文档专门针对 Python 的代码格式给出了建议，也就是俗称的 PEP 8。
文档地址：https://www.python.org/dev/peps/pep-0008/。

一、注释的作用

通过使用自己熟悉的语言，在程序中提示或解释某些关键代码的思路、作用和功能等，能够大大增强程序的可读性。（代码的可读性是非常重要的）

代码注释效果如下图：

没有添加注释的代码。

添加注释的代码。

二、注释的分类

注释分为两类：单行注释和多行注释。

单行注释

#作为单行注释的符号。只注释一行内容，语法如下：

# 注释内容

多行注释

可以注释多行内容，常用来为 Python 函数、类、模块等等添加功能、版本和作者等描述信息，语法如下：

#写法一：一对三双引号
"""
  第一行注释
  第二行注释
  第三行注释
"""

#写法二：一对三单引号
'''
  注释1
  注释2
  注释3
'''

三、注释的注意事项

Python 解释器（Python Interpreter）在执行程序（代码）时会忽略注释部分，不做任何处理。
当Python解释器解析Python文件的时候，一旦发现出现了#，就会认为#右边的文字全部都是说明性的文字，Python的解释器会直接跳过这一行，解释下一行代码。

极简单的注释可以放到一行代码的后面，一般习惯代码后面添加两个空格，再书写注释文字。

print('hello Python')  # 输出

#号和注释之间需要加上一个空格，不是强制，是规范。

Python 多行注释不支持嵌套，如下所示为错误写法：

'''
外层注释
    '''
    内层注释
    '''
'''

多行注释符号'''或"""也可以作为字符串的开始和结束标记。
Python 中当多行注释符号作为字符串的一部分出现时，就不能再将它们当做多行注释标记，而应该看做是字符串的一部分，如下所示：

#方式一
print("hello world ! hello python !")
print('hello world !')
print("""真香""")
print('''是真的''')

#方式二
str1 = "hello world ! hello python !"
str2 = 'hello world !'
str3 = """真香"""
str4 = '''是真的'''
print(str1)
print(str2)
print(str3)
print(str4)

"""
#执行结果都是
hello world ! hello python !
hello world !
真香
是真的
"""

四、什么时候需要使用注释

注释不是越多越好，对于一目了然的代码，不需要添加注释。
对于复杂的操作，应该在操作开始前写上若干行注释。
绝不要描述代码，假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么，代码注释要做功能性描述。

在一些正规的开发团队，通常会有代码审核的惯例，就是一个团队中彼此阅读对方的代码。

五、总结

注释是一个程序员必须要具有的良好编程习惯。

注释的作用有两个：

说明代码。
调试程序。

注释快捷键

单行注释：ctrl + /。
多行注释：没有，只能选中多行，在ctrl + /。

到此这篇关于Python基础之注释的用法的文章就介绍到这了,更多相关Python注释内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

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

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

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

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

注释标注解释,目的是帮助读者理解的文本也就是说,注释首先是文本,其二是说明,其三是思路,其四是例子注释有两种形式 1. # ... 单行注释用于对某句语句或语句块进行解释放在语句块的头行或一个语句的尾部 def see_seq(iterable): # 序列开始的下标为 0,也就是索引为 0 # 序列第一个元素的下标是0,也就是第n个元素的下标为 len(iterable) - 1 # for 循环自动处理索引.索引边界 # 自动依次取出 0 到 len(iterable)-1 索引对
Python注释、分支结构、循环结构、伪“选择结构”用法实例分析

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

Python的matplotlib模块绘制图形功能很强大,今天就用pyplot绘制一个简单的图形,图形中包括曲线.曲线上的点.注释和指向点的箭头. 1. 结果预览: 2. 代码如下: from matplotlib import pyplot as plt import numpy as np # 绘制曲线 x = np.linspace(2, 21, 20) # 取闭区间[2, 21]之间的等差数列,列表长度20 y = np.log10(x) + 0.5 plt.figure() # 添加一
Python基础之注释的用法

前言 Python代码的基本规范如下: 1.Python 文件将以 .py 为扩展名. 2.在Python中严格区分大小写(大小写敏感),如果写错了大小写,程序会报错. 3.Python中的每一行就是一条语句,每条语句以换行结束,不用;分号结束. 4.Python是缩进严格的语言,所以在Python中不要随便写缩进. 缩进的好处是强迫你写出缩进较少的代码,你会倾向于把一段很长的代码拆分成若干函数,从而得到缩进较少的代码. 缩进的坏处就是复制-粘贴功能失效了,当你重构代码时,粘贴过去的代码必须重新
详解Python变量与注释高级用法

目录 Python变量与注释高级用法 1.概述 2.变量 2.1.变量解包 2.2.给变量注明类型 2.3.变量命名原则 3.注释 3.1.注释类型 3.2.错误使用注释案例 Python变量与注释高级用法 1.概述好的变量和注释并非为计算机而写,而是为每个阅读代码的人而写.变量与注释是表达作者思想的基础,他们对代码质量的贡献母庸质疑. 2.变量 2.1.变量解包 1.什么是变量解包把一个可迭代对象的所有成员,一次性的赋值给多个变量的过程就是变量解包. 2.变量解包语法 # 变量解包 use
Python基础之循环语句用法示例【for、while循环】

本文实例讲述了Python基础之循环语句用法.分享给大家供大家参考,具体如下: while 循环 Python中while语句的一般形式: while 判断条件: statements 同样需要注意冒号和缩进.另外,在Python中没有do..while循环. 以下实例使用了 while 来计算 1 到 100 的总和: #!/usr/bin/env python3 n = 100 sum = 0 counter = 1 while counter <= n: sum = sum + c
Python基础之函数基本用法与进阶详解

本文实例讲述了Python基础之函数基本用法与进阶.分享给大家供大家参考,具体如下: 目标函数参数和返回值的作用函数的返回值进阶函数的参数进阶递归函数 01. 函数参数和返回值的作用函数根据有没有参数以及有没有返回值,可以相互组合,一共有 4 种组合形式无参数,无返回值无参数,有返回值有参数,无返回值有参数,有返回值定义函数时,是否接收参数,或者是否返回结果,是根据实际的功能需求来决定的! 如果函数内部处理的数据不确定,就可以将外界的数据以参数传递到函数内
Python基础之变量基本用法与进阶详解

本文实例讲述了Python基础之变量基本用法与进阶.分享给大家供大家参考,具体如下: 目标变量的引用可变和不可变类型局部变量和全局变量 01. 变量的引用变量和数据都是保存在内存中的在 Python 中函数的参数传递以及返回值都是靠引用传递的 1.1 引用的概念在 Python 中变量和数据是分开存储的数据保存在内存中的一个位置变量中保存着数据在内存中的地址变量中记录数据的地址,就叫做引用使用 id() 函数可以查看变量中保存数据所
Python 基础教程之包和类的用法

Python 基础教程之包和类的用法建立一个文件夹filePackage 在filePackage 文件夹内创建 __init__.py 有了 __init__.py ,filePackage才算是一个包,否则只是算一个普通文件夹. 在filePackage 文件夹内创建 file.py file.py 代码如下: #!/usr/bin/env python3 # -*- coding: utf-8 -*- from datetime import datetime class MyFile(
Python基础教程之内置函数locals()和globals()用法分析

本文实例讲述了Python基础教程之内置函数locals()和globals()用法.分享给大家供大家参考,具体如下: 1. 这两个函数主要提供,基于字典的访问局部变量和全局变量的方式. python 使用叫做名字空间的东西来记录变量的轨迹.名字空间是一个字典 ,它的键就是字符串形式的变量名字,它的值就是变量的实际值. 名字空间可以像 Python 的 dictionary 一样进行访问. 在一个 Python 程序中的任何一个地方,都存在几个可用的名字空间. 每个函数都有着自已的名字空间,叫做
Python基础学习之类与实例基本用法与注意事项详解

本文实例讲述了Python基础学习之类与实例基本用法与注意事项.分享给大家供大家参考,具体如下: 前言和其他编程语言相比,Python用非常少的新语法和语义将类加入到语言中.Python的类提供了面向对象编程的所有标准特性:类继承机制允许多个基类,派生类可以覆盖它基类的任何方法,一个方法可以调用基类中相同名称的的方法.对象可以包含任意数量和类型的数据.和模块一样,类也拥有Python天然的动态特性:它们在运行时创建,可以在创建后修改. Python的类 Python类实例时,先调用__new_
Python基础学习之时间转换函数用法详解

本文实例讲述了Python基础学习之时间转换函数用法.分享给大家供大家参考,具体如下: 前言 python的时间格式分为多种,几种格式之间的转换方法时常是我们遇到的而且是经常忘记的点,python不像php,时间字符串和datetime是一起的,只需要strtotime和date函数就可以相互转化.虽然网上已经有很多python时间转换的文章,但是由于作者本人经常做海外业务,需要各种时区之间的转换,所以这篇文章会对按时区转换各种时间格式做一个总结. 转换方法图示(图片转自网络): 一.字符串转时