Python 中如何写注释


Posted in Python onAugust 28, 2020

在写 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 注释的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
使用Python编写vim插件的简单示例
Apr 17 Python
Python抽象类的新写法
Jun 18 Python
安装ElasticSearch搜索工具并配置Python驱动的方法
Dec 22 Python
解决python opencv无法显示图片的问题
Oct 28 Python
python读写csv文件并增加行列的实例代码
Aug 01 Python
OpenCV+face++实现实时人脸识别解锁功能
Aug 28 Python
python可视化实现KNN算法
Oct 16 Python
Python绘制全球疫情变化地图的实例代码
Apr 20 Python
Python批量将csv文件转化成xml文件的实例
May 10 Python
使用tensorflow 实现反向传播求导
May 26 Python
Python OpenCV 图像平移的实现示例
Jun 04 Python
Python利用FlashText算法实现替换字符串
Mar 31 Python
Python操作Word批量生成合同的实现示例
Aug 28 #Python
Python接口自动化测试的实现
Aug 28 #Python
解决python和pycharm安装gmpy2 出现ERROR的问题
Aug 28 #Python
Python自动登录QQ的实现示例
Aug 28 #Python
python opencv pytesseract 验证码识别的实现
Aug 28 #Python
简单的命令查看安装的python版本号
Aug 28 #Python
python进行OpenCV实战之画图(直线、矩形、圆形)
Aug 27 #Python
You might like
PHILIPS D1835/D1875的电路分析与打理
2021/03/02 无线电
PHP中替换键名的简易方法示例详解
2014/01/07 PHP
php中判断数组相等的方法以及数组运算符介绍
2015/03/30 PHP
php中ob函数缓冲机制深入理解
2015/08/03 PHP
利用jQuery操作对象数组的实现代码
2011/04/27 Javascript
javascript获取select的当前值示例代码(兼容IE/Firefox/Opera/Chrome)
2013/12/17 Javascript
JavaScript将数据转换成整数的方法
2014/01/04 Javascript
Egret引擎开发指南之编译项目
2014/09/03 Javascript
JavaScript字符串对象toLowerCase方法入门实例(用于把字母转换为小写)
2014/10/17 Javascript
JavaScript数组常用操作技巧汇总
2014/11/17 Javascript
在jQuery中使用$而避免跟其它库产生冲突的方法
2015/08/13 Javascript
基于Jquery和html5实现炫酷的3D焦点图动画
2016/03/02 Javascript
基于zepto.js简单实现上传图片
2016/06/21 Javascript
js HTML5 Canvas绘制转盘抽奖
2020/09/13 Javascript
利用jQuery.Validate异步验证用户名是否存在(推荐)
2016/12/09 Javascript
实例浅析js的this
2016/12/11 Javascript
防止页面url缓存中ajax中post请求的处理方法
2017/10/10 Javascript
如何获取TypeScript的声明文件.d.ts
2018/05/01 Javascript
解决Vue中引入swiper,在数据渲染的时候,发生不滑动的问题
2018/09/27 Javascript
微信小程序 扭蛋抽奖机css3动画实现详解
2019/07/19 Javascript
简述ES6新增关键字let与var的区别
2019/08/23 Javascript
layui自定义工具栏的方法
2019/09/19 Javascript
python 实现插入排序算法
2012/06/05 Python
详谈Python基础之内置函数和递归
2017/06/21 Python
解决Python 中英文混输格式对齐的问题
2018/07/16 Python
使用python判断jpeg图片的完整性实例
2019/06/10 Python
Django 路由控制的实现
2019/07/17 Python
解决Pytorch 训练与测试时爆显存(out of memory)的问题
2019/08/20 Python
python3 requests库文件上传与下载实现详解
2019/08/22 Python
Python使用jpype模块调用jar包过程解析
2020/07/29 Python
Python 实现微信自动回复的方法
2020/09/11 Python
Python 创建守护进程的示例
2020/09/29 Python
用HTML5的canvas实现一个炫酷时钟效果
2016/05/20 HTML / CSS
会计专业毕业生自我评价
2013/09/25 职场文书
银行实习生的自我评价
2013/12/09 职场文书
远程培训的心得体会
2014/09/01 职场文书