Python编程第6课:15个编程好习惯之一,使用注释符
off999 2024-10-09 14:06 37 浏览 0 评论
【回顾:Python编程第5课作业答案】
第1题:D 第2题:sum= 17 第3题:第1行补充“sum=0”,第5行补充“sum=sum+i”
你答对了吗?
近日,大陈看到一个程序员总结的15个编程好习惯,其中第2条就是讲到注释符的使用,原文分享如下:
2. 优秀的代码文档跟编程语言知识一样重要。在代码源文件中,为每个主要的代码段添加注释,解释代码的基本逻辑。最好注明程序的构建和修改日期,以及修改的原因也是非常有必要的。
随着我们Python学习的深入,你会发现我们的程序越来越复杂,越来越长,可能在写的时候你还是很清楚的,可是说不定过了一段时间,你再回头看,就会懵了,我当时写了啥,为什么要这么写?
因此就像上面引用的经验分享那样,学会使用注释符在你的程序中写上说明,是很重要的,如果你哪天成为一个职业程序员,当你修改同事的代码的只用了2小时,但为了修改看懂这些代码确用了2天,你会不会抓狂呢?
好了,废话不多说,我们先来看看Python的注释符有几种用法:
一、Python的注释符
1、单行注释
Python 使用“#”(输入法保持英文状态,按住Shift键不松手,再按数字3)作为单行注释的符号,语法格式为:
# 注释内容从#开始,直到这行结束为止的所有内容都是注释。Python 解释器遇到#时,会忽略它后面的整行内容,不会执行。
说明多行代码的功能时一般将注释放在代码的上一行;
说明单行代码的功能时一般将注释放在代码的右侧;
例如:
#这是一个Python累加器
sum=0#变量sum赋初始值为0
#变量sum开始累加
sum=sum+1
sum=sum+2
sum=sum+3
sum=sum+4
print("sum=",sum)#输出变量sum的值2、多行注释
多行注释指的是一次性注释程序中多行的内容(包含一行)。
Python 使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容,具体格式如下:
'''
这是一个Python计数器的案例
编写时间:2020年6月14日
作者:大陈
'''
sum=0#变量sum赋初始值
#变量sum开始计数
sum=sum+1
sum=sum+1
sum=sum+1
print("sum=",sum)#输出变量sum的值或者
"""
这是一个Python计数器的案例
编写时间:2020年6月14日
作者:大陈
"""
sum=0#变量sum赋初始值
#变量sum开始计数
sum=sum+1
sum=sum+1
sum=sum+1
print("sum=",sum)#输出变量sum的值多行注释通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。
二、Python注释符的2大用途
1、起提示、说明、解释的作用
注释用来向用户提示或解释某些代码的作用和功能,它可以出现在代码中的任何位置。Python 解释器在执行代码时会忽略注释,不做任何处理,就好像它不存在一样。注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书!
2、在程序调试时缩小错误所在范围
在调试(Debug)程序的过程中,注释还可以用来临时移除无用的代码。举个例子,如果你觉得某段代码可能有问题,可以先把这段代码注释起来,让 Python 解释器忽略这段代码,然后再运行。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。
在调试程序的过程中使用注释可以缩小错误所在的范围,提高调试程序的效率。
三、Python注释符使用的注意事项
大陈在CSDN上看到youxin2012写了一篇文章,非常系统,分15种情况写了书写注释时的注意事项,例如源文件头部、函数头部等怎么书写注释、书写哪些内容都有举实例,对于初学者养成良好的编程习惯有很好的借鉴意义,虽然他不是用的Python语言,但使用注意事项是相通的,这里分享给大家。
相关推荐
- 系统集成项目管理工程师难考吗
-
系统集成项目管理工程师考试的普遍通过率是在10%左右,但是并不表示考试真的有那么难。因为考试本身没有报考条件的限制,且考试报名费用很低,很多人都不重视考试。所以通过率普遍偏低,只要你认真备考,有一...
- 360影视大全下载2025免费版(下载360影视大全最新版下载安装到手机版)
-
你好朋友360影视大全里的很多视频都是免费的,建议安装最新的360影视大全就可以了打开360视频,搜索自己需要的视频,点击360播放器右下角的下载箭头,即可将视频进行下载,下载完毕之后视频会保存在36...
- 360安全卫士手机版下载(360安全卫士官方免费下载手机版5.5.0)
-
相当靠谱360手机卫士是一款由奇虎网推出的功能强、效果好、受用户欢迎的上网安全软件。360安全卫士拥有查杀木马、清理插件、修复漏洞、电脑体检、保护隐私等多种功能,并独创了“木马防火墙”“360密盘”等...
- deepin和统信uos(统信和deepin的区别)
-
差不多。1Deepin原名LinuxDeepin、deepinos、深度操作系统,于2014年4月改名Deepin。deepin团队基于Qt/C++(用于前端)和Go(用于后端)开发了的全新深度桌...
- 三星驱动(三星驱动板)
-
驱动是必须装的,但不需要单独安装驱动。 1、电脑的所有硬件,必然要装驱动,键盘、鼠标什么的,都是有驱动的。驱动是软件和硬件结合的桥梁。但多数普通常见的硬件,驱动是widnows系统自带的,不需要用户...
- u盘启动杀毒软件(u盘杀毒系统)
-
有,但是主要是专杀工具,全面的综合杀毒软件基本上没有,因为没什么用。 1、放在U盘里的杀毒软件,就是不安装,也不监控,只杀毒的软件。 2、目前的杀毒软件的工作机制,主要是监控,监控电脑不感染病...
- 联想维修站点查询官网(联想 维修 服务网点)
-
您可以在联想的官方网站上查询到附近的授权维修服务点,或者拨打联想的客服电话寻求帮助。在维修服务点,您可以享受到专业的维修服务,包括硬件故障、软件问题、系统优化等方面的维护和维修。维修人员将会根据您的电...
- 电脑不识别移动硬盘(移动硬盘灯亮但不读取)
-
电脑不能识别移动硬盘可能是由于以下原因造成的:1.电脑和硬盘之间的连接首先,可以确保移动硬盘正确连接到电脑上,检查USB接口是否松动或损坏,可以尝试更换USB线或者尝试连接到其他USB接口看是否能够...
- 键盘的win键在哪里(电脑键盘的win键在哪里)
-
win键就是电脑键盘上显示WINDOWS标志的按键。位于CTRL键与ALT键两个键之间,win键的具体位置一般电脑键盘上有左右两个。Windows键是一种特殊的键,通常位于键盘的左下角。它的图案是一个...
- ghost全盘备份步骤图(用ghost怎么进行全盘备份)
-
可以用手动备份到指定分区。一、用一键Ghost还原中的“中文向导”备份开始-程序-一键Ghost-选出“中文向导”,Ghost中文向导-1、备份文件默认是“第1硬盘第1分区”,如果不是,将鼠标指针移...
-
- 键盘的windows键是哪一个(键盘上windows键是哪个键)
-
windows键就是电脑键盘上ctrl键和alt键之间的按键,位于左下角。它带着微软的徽标,跟开始菜单一样的图标,它属于辅助按键,主要与其它按键组合使用,实现一些特定的功能,组合成多种快捷操作方式。这里上面所知的Win键其实就是键盘上的Wi...
-
2025-12-31 10:51 off999
- win10打开设置快捷键(win10打开设置快捷键是什么)
-
1、首先打开电脑,在任务栏的语言地方点击一下再点击语言首选项。2、然后在新的界面里点击选择左侧“高级设置”按钮。3、之后在新的界面里点击选择“更改语言栏热键”按钮。4、然后在新的界面里点击选择“更改热...
- flash插件下载手机版下载安装
-
华为手机的最新系统版本已经不再支持FlashPlayer,这是由于Adobe已于2020年底停止更新和支持FlashPlayer。因此,如果您使用最新的华为手机系统,可能无法安装和使用Flash...
欢迎 你 发表评论:
- 一周热门
-
-
抖音上好看的小姐姐,Python给你都下载了
-
全网最简单易懂!495页Python漫画教程,高清PDF版免费下载
-
Python 3.14 的 UUIDv6/v7/v8 上新,别再用 uuid4 () 啦!
-
飞牛NAS部署TVGate Docker项目,实现内网一键转发、代理、jx
-
python入门到脱坑 输入与输出—str()函数
-
宝塔面板如何添加免费waf防火墙?(宝塔面板开启https)
-
Python三目运算基础与进阶_python三目运算符判断三个变量
-
(新版)Python 分布式爬虫与 JS 逆向进阶实战吾爱分享
-
失业程序员复习python笔记——条件与循环
-
系统u盘安装(win11系统u盘安装)
-
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)
