当前位置：网站首页 > 技术资源 > 正文

Python如何在代码中添加适当注释（python如何注释多行代码）

off999 2024-10-24 12:27 37 浏览 0 评论

Python中有三种形式的代码注释：块注释、行注释、以及文档注释（docstring）。那么，怎么适当地使用这三种注释呢？

块注释或行注释：每条注释以#号开始。这种注释一般使用在那些复杂的算法或者操作的地方，这样的注释可以让别人或者自己在一段时间之后重新阅读这段代码的时候一目了然。
注释和代码之间尽量留出一定的距离，下面两行代码显然第一行的阅读性要好。
x = x + 1 # increace x by 1
x = x + 1 # increace x by 1
文档注释：文档注释使用的是三引号。这种注释主要是为希望使用该程序的人准备的，它描述的是该程序或者函数“能做什么”而不是“怎么做”。这种注释要清楚地描述方法的功能，并对参数、以及可能出现的问题进行必要的说明。如下：我们需要为这些函数做简单的说明。
def binary_search(v, h)
"""使用二分法搜索检查需要的元素
"""
如果编写某段程序时需要我们使劲思考的话，那么就应该编写注释，以便别人不会在这个地方绞尽脑汁。
很多程序员会在代码写上一些以"TODO"或"FIXM"开始的注释，这是为了提醒他们之后解决一些还未解决的问题。
另外，如果一个地方需要我们用大量的注释去说明的话，这个时候我们就应该先对这些代码进行整理，拆分成更小的代码块，以便我们分开注释。
防止注释与代码重复。注释应该是用来说明代码的功能的，而不是对代码本身的解释。
最后，过时的注释还不如不注释。代码不断更新，而注释却没有更新，这会误导我们对那段代码的理解。

python怎么注释

上一篇：python 入门学习---模块导入三种方式及中文注释
下一篇：菜鸟学Python之二:关于注释的那些事

相关推荐

autocad2012产品密钥（cad2012的产品密钥是什么）: CAD2012产品密钥和序列号序列号：400-45454545钥匙：651D1序列号：356-72378422钥匙：001D1序列号：400-45454545钥匙：001D1序列号：666-6969...

软件误删怎么找回来（软件删掉怎么找回）

桌面语言栏不见了怎么办（桌面语言栏不见了怎么办呢）: 如果您的语言栏在某个应用程序或操作系统中消失了，您可以尝试以下方法来恢复它。首先，您可以检查操作系统的设置，查看语言和区域选项是否正确设置。如果设置正确，但语言栏仍然不可见，您可以尝试重新启动计算机，...

怎么装win98（怎么装win7系统教程）: 如何安装windows98　　一、具体安装步骤　　备份好重要文件之后，就可以安装windows98了。　　第一步：启动安装程序。　　用户如果原来已安装了windows95/97/98，现在拟对其进行升...

u盘写保护无法格式化怎么解除

app下载官网（欧歌影视app下载官网）: 需要先进入佳能官网的下载页面，选择手机APP下载选项，根据手机操作系统的不同选择相应的下载链接即可成功下载佳能手机APP。下载链接通常会在网站的首页或者是产品页面上提供。总的来说，下载佳能手机APP非...

qq空间相册密码怎么破

互盾手机数据恢复软件下载（互盾数据恢复软件可以免费使用一次吗）: 要的。手机如果可以连电脑当做u盘识别就可以用恢复软件。比如用安易。至于能不能出现盘符，可以网上查一下你这个手机型号可不可以，或者问问手机售后。1、安装互盾安卓恢复大师，运行软件后，将手机连接到电脑上...

电脑wifi突然变成红叉搜不到: 1、WiFi功能未开启：很多时候出现WiFi红色叉叉图标，可能就是无线WiFi的开关或者按键没有开启导致的。一般的笔记本键盘上面都有一个F5开启WiFi的功能，有的需要结合Fn功能键一起按。每个品牌的...

正版win10系统一键重装官网（一键装机win10正版系统）: 1、下载小白一键重装软件，打开软件后选择我们要安装的系统。?2、接着小白给出我们一些常用的电脑软件，大家可根据自己需要进行下载。?3、然后就是我们就耐心的等待系统镜像的下载吧。?4、部署环境完成后我们...

windows8系统自己怎么装（如何安装windows 8）: 要在线安装Windows8系统，您可以按照以下步骤操作：1.准备安装媒体：在您的计算机上打开一个现代的网络浏览器（如Chrome、Firefox或Edge），然后前往Microsoft...

win10登录选项没有密码设置（win10没有登陆密码框）: 是该电脑没设置密码，所以登录时看不到密码选项。电脑开机后，要设置密码，设置完成后，重新启动电脑，就会出现密码登录框，输入密码并正确后，电脑才能正常进入系统。1、首先进入安全模式；进入安全模式教程：2、...

小白刷机官网（小白刷机助手）: 平板的话，和处理器有关，如果处理器只支持win8是不能刷win10的。

windows关闭端口命令（windows 关端口）: 1、点击控制面板。2、进入控制面板，然后点击系统和安全。3、进入系统和安全，点击Windows防火墙。4、进入Windows防火墙，点击左侧的高级设置。5、进入防火墙高级设置，点击入站规则。6、点击入...

360免费wifi老版本（360免费wifi2019下载安装）

取消回复欢迎你发表评论:

一周热门

最近发表

首页
收录
顶部