Python 中如何写注释

在写 Python 代码的时候，一个很好的编码实践就是使得你的代码简洁，易懂。组织代码，设置变量，以及给函数有意义的名字，都是几个不错的方法。

另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如，如果你写了一个复杂的正则表达式，你可以添加一个注释，描述代码做了什么。

在你的 Python 代码中添加注释，在将来你阅读你的代码时，可以节省很多的时间和努力。比如说，你想修改一段你在几个月前或者几年前写的脚本。很可能你不记得为什么你写了一些比较复杂的代码，除非你添加一段注释。这个注释同时也可以帮助其他开发者理解你的代码，以及代码的目的。

注释应该很短，并且切中要点。不要解释那些很容易读懂的代码。

本文主要讲解在 Python 中编写注释的基础知识。

一、在 Python 中写注释

Python 会忽略井号(#)后面的一切。

注释可以添加到行首或者和其他代码在一行。

# This is a Python comment.
print("Hello World") # This is an inline Python comment.

井号后面的空格不是强制性的，但是它会提高注释的可读性。

在字符串中间的井号并不意味着是一段注释的开始。此时，它仅仅是一个简单的井号。

paragraph = "# Hash inside quotes is not a comment."

Comments should be at the same indent level as the code beneath it:

```py
def factorial(n):
 if n == 0:
 return 1
 else:
 # Use the factorial function
 return n * factorial(n-1)

如果你的文本编辑器支持语法高亮，注释通常都使用绿色代表。

注释在调试脚本的时候非常有用。与其删除一些行或者代码块，不如将他们暂时注释掉：

# for fruit in fruits:
# print(fruit)

二、Python 中的多行注释(注释块)

不像其他流行的编程语言，Python 仅仅支持单行注释。

在 Python 中编写多行注释的最简单方式就是每行添加一个注释。

# This is the first line.
# This is the second line.

另外一个选项就是使用 docstrings

Docstrings 是一个多行字符串，用来对模块，函数，类和方法进行文档化的。

一个 Docstrings 以(""") 开始，可以是 一行或者多行：

"""This is
a multiline
docstring.
"""

Docstrings 不是技术性的注释。当 Docstrings 在模块，函数，类，或者方法的前面出现的时候，它在字节码中结束，并且变成__doc__特殊属性的对象。

你更应该使用单行注释。

三、Shebang

如果你阅读 Python 脚本，你可能注意到第一行以#!字符开始，接着是 Python 解释器的路径。

#!/usr/bin/env python3

这一串字符串被称为shebang,它被用来告诉操作系统，应该使用什么解释器来解析文件。脚本以 shebang 开头，并且可以在终端中直接运行，而不用在脚本输入python。

因为 shebang 以 井号开头，它被认为是一个注释，并且自动被 Python 解释器忽略。

四、总结

编写注释是一个非常好的实践，它帮助其他开发者，包括未来的自己，来理解这段代码在做什么。

在 Python 中，所有以井号开头的直到行末的，都被认为是一段注释。

以上就是Python 中写注释的方法的详细内容，更多关于python 注释的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • python注释和运算符详解

    python注释和运算符详解

    目录 1.多文件项目演练 2.注释(解释器不会解释#右侧内容) 2.1单行注释(行注释) 2.2多行注释(块注释) 3.算术运算符 3.1运算符 3.2优先级 总结 1.多文件项目演练 在day02下创建两个python文件 先点中一个文件,右键运行:右上角会出现文件框: 运行第二个文件,步骤也同样如此: 删除输出框内容 2.注释(解释器不会解释#右侧内容) 2.1单行注释(行注释) #号后跟个空格,就不会有语法错误 # 这是第一个注释 print("hello world") # 这

  • Python全栈之运算符详解

    目录 1. 算数_比较_赋值_成员 1.1 算数运算符 1.2 比较运算符 1.3 赋值运算符 1.4 成员运算符 2. 身份运算符 小提示: 3. 逻辑运算符 3.1 位运算符 3.2 小总结 4. 代码块_单项_双项分支 4.1 代码块 4.2 流程控制 4.3 单项分支 4.4 双项分支 5. 小作业 总结 1. 算数_比较_赋值_成员 1.1 算数运算符 算数运算符: + - * / // % ** # + var1 = 7 var2 = 90 res = var1 + var2 pri

  • python代码如何注释

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

  • Python学习之运算符号

    目录 1.算数运算符: 2.赋值运算符: 3.比较运算符 4.逻辑运算符 5. 成员运算符 总结 大至分为以下5类运算符号 算数运算符 赋值运算符 比较运算符 逻辑运算符 成员运算符 算数运算符 和 赋值运算符 运算是得到真实的结果 比较运算符 逻辑运算符 和 成员运算符 运算得到的 是布尔值 真True 或 假False 1.算数运算符: +          加          -          减          *          乘          /          除

  • python基础之基本运算符

    python基础之基本运算符

    目录 Python基本运算符 算数运算符 比较运算符 逻辑运算符 赋值运算符 总结 Python基本运算符 算数运算符 # + - * / % ** // 算数运算符 # 定义如下运算符 a=7 b=3 print(a+b) print(a-b) print(a*b) print(a/b) print(a%b) print(a//b) # 地板除,相除取整,也可进行复合运算 比较运算符 # == != < > >= <= 比较运算符 a,b=10,5 print(a==b) pri

  • Python 中如何写注释

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

  • python中如何写类

    类的定义 Python中,定义类是通过class关键字,例如我们定义一个存储学生信息的类: class Student(object): pass class后面紧接着是类名,即Student,类名通常是大写开头的单词,紧接着是(object),表示该类是从哪个类继承下来的.通常,如果没有合适的继承类,就使用object类,这是所有类最终都会继承的类. 定义好了Student类,就可以根据Student类创建出Student的实例,创建实例是通过类名+()实现的: >>> bart =

  • 详解Python中如何写控制台进度条的整理

    本文实例讲述了Python显示进度条的方法,是Python程序设计中非常实用的技巧.分享给大家供大家参考.具体方法如下: 首先,进度条和一般的print区别在哪里呢? 答案就是print会输出一个\n,也就是换行符,这样光标移动到了下一行行首,接着输出,之前已经通过stdout输出的东西依旧保留,而且保证我们在下面看到最新的输出结果. 进度条不然,我们必须再原地输出才能保证他是一个进度条,否则换行了怎么还叫进度条? 最简单的办法就是,再输出完毕后,把光标移动到行首,继续在那里输出更长的进度条即可

  • Python 中写注释的方法

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

  • 详解python中GPU版本的opencv常用方法介绍

    引言 本篇是以python的视角介绍相关的函数还有自我使用中的一些问题,本想在这篇之前总结一下opencv编译的全过程,但遇到了太多坑,暂时不太想回看做过的笔记,所以这里主要总结python下GPU版本的opencv. 主要函数说明 threshold():二值化,但要指定设定阈值 blendLinear():两幅图片的线形混合 calcHist() createBoxFilter ():创建一个规范化的2D框过滤器 canny边缘检测 createGaussianFilter():创建一个Ga

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

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

  • Python中的单行、多行、中文注释方法

    一.python单行注释符号(#) python中单行注释采用 #开头 示例:#this is a comment 二.批量.多行注释符号 多行注释是用三引号"' "'包含的,例如: 三.python中文注释方法 今天写脚本的时候,运行报错: SyntaxError: Non-ASCII character '\xe4' in file getoptTest.py on line 14, but no encoding declared; see http://www.python.o

  • python中的三种注释方法

    python中的三种注释方法

    目录 python注释方法 方式1 方式2 方式3 python小技巧 开头注释 设置路径 python注释方法 方式1 单行注释:shift + #(在代码的最前面输入,非选中代码进行注释) 多行注释:同单行一样在每一行的前面输入shift + #(较麻烦了) 方式2 单行和多行一样的方式:Ctr+ /  (前提是选中需要注释的代码) 方式3 输入''' '''或者""" """,将要注释的代码插在中间 ''' 这是多行注释,使用单引号. 这是

  • 代码中到底应不应当写注释？

    当很多前辈教育后辈应当多写注释的时候,当网络上充满了有关程序员从不写注释的段子的时候,这是一个非常有争议的话题.作为一个标题党,容我先修正一下我的观点:我认为如果代码写得足够好,那么大多数注释是多余的,我们应该通过写出更好的代码来代替更多注释. 注释的确有其用途,但大部分情况下,程序员在滥用注释.我是反对夹杂在代码间的注释的,我认为注释应当从代码中独立出来--通常被称为文档. 请看下面一段代码. 复制代码 代码如下: /* /static/market/checkout.js 2014.7.2

  • python中使用xlrd读excel使用xlwt写excel的实例代码

    python中使用xlrd读excel使用xlwt写excel的实例代码

    在数据分析和运营的过程中,有非常多的时候需要提供给别人使用,提供的形式有很多种,最经常使用的是Excel, 而 数据的统计和分析采用的是 python, 使用 python 把数据存在Excel 也是常见的事情,也有很多的库帮我们做了很多引擎的事情,比如说xlrd 和xlwt, 分别为读excel和写excel. 安装xlrd和xlwt python中安装第三方模块都较为简单,同样的使用pip 命令就可以: pip install xlrd pip install xlwt 在这里准备上一份Ex

随机推荐