Python 中如何写注释
作者:雪梦科技 发布时间:2022-07-10 21:53:11
在写 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 中,所有以井号开头的直到行末的,都被认为是一段注释。
来源:https://cloud.tencent.com/developer/article/1655148
猜你喜欢
- 最近在做个大数据量的录入,为了方便客户输入,需要通过方向键来移动到输入框中,本代码仅供学习、研究,请勿用于其它用途:D下面贴的代码只是贴出来
- 不知大家对精华区的表格排序终极优化是否还有记忆,当时讨论的结果曾以为是最快的JS排序了,实则不然,按前段时间我发的DHTML性能提升帖(转译
- 移动互联网被称为“第五次科技革命”,而随着iPhone和Android等智能手机的日渐流行和iPad等平板电脑的出现,移动互联网的潜力和趋势
- TEMPLATESDjango 1.8的新特性一个列表,包含所有在Django中使用的模板引擎的设置。列表中的每一项都是一个字典,包含某个引
- 一、概述 对象是Oracle8i以上版本中的一个新的特性,对象实际是对一组数据和操作的封装,对象的抽象就是类。在面向对象技术中,对象涉及到以
- 引言除非您正在对服务进行原型设计,否则您可能会关心应用程序的内存使用情况。内存占用更小,基础设施成本降低,扩展变得更容易/延迟。尽管 Go
- 1.SQL Server 2005中的存储过程并发问题问:我在SQL Server2005中遇到了并发问题。我持有车票的公共汽车上有一些空闲
- server:#coding=utf-8from BaseHTTPServer import BaseHTTPRequestHandleri
- 只添加了一些自己想到的常用的功能,欢迎大家补充添加自己的好的思路. 通用的正则和方法可以写在RegExpObj中,
- 一、查询操作可以使用Dataframe的index属性和columns属性获取行、列索引。import pandas as pddata =
- 以下的文章主要是对MySQL limit查询优化的具体内容的介绍,我们大家都知道MySQL数据库的优化是相当重要的。其他最为常用也是最为需要
- 四、XML应用分类 总的说来的XML的应用可分为四类: (1)应用于客户需要与不同的数据源进行交互时。数据可能来自不同的数据库,他们都有各自
- table估计每个跟web打过交道的人都会经常接触到,跟js结合能做出很多不错的体验。这里打算结合js做一个系列,包括一些操作和效果,虽然现
- 一、前言上次写了一个俄罗斯方块,感觉好像大家都看懂了,这次就更新一个植物大战僵尸吧二、引入模块import pygameimport ran
- 简介这是一篇介绍网页设计原则的文章。在互联网迅速发展的今天,各种web 2.0网站竞争激烈,你死我亡。Jini, D
- 本文实例讲述了Python使用matplotlib 模块scatter方法画散点图。分享给大家供大家参考,具体如下:# -*-coding:
- 本文实例讲述了Python3的urllib.parse常用函数。分享给大家供大家参考,具体如下:1、获取url参数>>>
- 利用pymongo包进行数据库的连接,使用xlrd包读取excel数据,由于二者数据结构的不同,要将excel格式数据转换为json格式数据
- 在没步入正轨之前,先给大家介绍JavaScript 特殊字符你可以在 JavaScript 中使用反斜杠来向文本字符串添加特殊字符。插入特殊
- //TransmitFile实现下载protected void Button1_Click(object sender, EventArg