百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

Python编程第6课:15个编程好习惯之一,使用注释符

off999 2024-10-09 14:06 22 浏览 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语言,但使用注意事项是相通的,这里分享给大家。

相关推荐

Python函数参数和返回值类型:让你的代码更清晰、更健壮

在Python开发中,你是否遇到过这些抓狂时刻?同事写的函数参数类型全靠猜调试两小时发现传了字符串给数值计算函数重构代码时不知道函数返回的是列表还是字典今天教你两招,彻底解决类型混乱问题!让你的...

有公司内部竟然禁用了python开发,软件开发何去何从?

今天有网友在某社交平台发文:有公司内部竟然禁止了python开发!帖子没几行,评论却炸锅了。有的说“太正常,Python本就不适合做大项目”,还有的反驳“飞书全员用Python”。暂且不说这家公司...

写 Python 七年才发现的七件事:真正提高生产力的脚本思路

如果你已经用Python写了不少脚本,却总觉得代码只是“能跑”,这篇文章或许会刷新你对这门语言的认知。以下七个思路全部来自一线实战,没有花哨的概念,只有可落地的工具与习惯。它们曾帮我省下大量无意义...

用Python写一个A*搜索算法含注释说明

大家好!我是幻化意识流。今天我们用Python写一个A*搜索算法的代码,我做了注释说明,欢迎大家一起学习:importheapq#定义搜索节点类,包括当前状态、从初始状态到该状态的代价g、从该状态...

使用python制作一个贪吃蛇游戏,并为每一句添加注释方便学习

今天来设计一个贪吃蛇的经典小游戏。先介绍下核心代码功能(源代码请往最后面拉):游戏功能:-四个难度等级:简单(8FPS)、中等(12FPS)、困难(18FPS)、专家(25FPS)-美...

Python 之父 Guido van Rossum 宣布退休

Python之父GuidovanRossum在推特公布了自己从Dropbox公司离职的消息,并表示已经退休。他还提到自己在Dropbox担任工程师期间学到了很多东西——Python的类型注解(T...

4 个早该掌握的 Python 类型注解技巧

在Python的开发过程中,类型注解常常被忽视。但当面对一段缺乏类型提示、逻辑复杂的代码时,理解和维护成本会迅速上升,极易陷入“阅读地狱”。本文整理了4个关于Python类型注解的重要技巧...

让你的Python代码更易读:7个提升函数可读性的实用技巧

如果你正在阅读这篇文章,很可能你已经用Python编程有一段时间了。今天,让我们聊聊可以提升你编程水平的一件事:编写易读的函数。请想一想:我们花在阅读代码上的时间大约是写代码的10倍。所以,每当你创建...

Python异常模块和包

异常当检测到一个错误时,Python解释器就无法继续执行了,反而出现了一些错误的提示,这就是所谓的“异常”,也就是我们常说的BUG例如:以`r`方式打开一个不存在的文件。f=open('...

别再被 return 坑了!一文吃透 Python return 语句常见错误与调试方法

Pythonreturn语句常见错误与调试方法(结构化详解)一.语法错误:遗漏return或返回值类型错误错误场景pythondefadd(a,b):print(a+b)...

Python数据校验不再难:Pydantic库的工程化实践指南

在FastAPI框架横扫Python后端开发领域的今天,其默认集成的Pydantic库正成为处理数据验证的黄金标准。这个看似简单的库究竟隐藏着哪些让开发者爱不释手的能力?本文将通过真实项目案例,带您解...

python防诈骗的脚本带注释信息

以下是一个简单但功能完整的防诈骗脚本,包含URL检测、文本分析和风险评估功能。代码结构清晰,带有详细注释,适合作为个人或家庭防诈骗工具使用。这个脚本具有以下功能:文本诈骗风险分析:检测常见诈骗关键...

Python判断语句

布尔类型和比较运算符布尔类型的定义:布尔类型只有两个值:True和False可以通过定义变量存储布尔类型数据:变量名称=布尔类型值(True/False)布尔类型不仅可以自行定义,同时也可通过...

使用python编写俄罗斯方块小游戏并为每一句添加注释,方便学习

先看下学习指导#俄罗斯方块游戏开发-Python学习指导##项目概述这个俄罗斯方块游戏是一个完整的Python项目,涵盖了以下重要的编程概念:-面向对象编程(OOP)-游戏开发基础-数据...

Python十大技巧:不掌握这些,你可能一直在做无用功!

在编程的世界里,掌握一门语言只是起点,如何写出优雅、高效的代码才是真功夫。Python作为最受欢迎的编程语言之一,拥有简洁明了的语法,但要想真正精通这门语言,还需要掌握一些实用的高级技巧。一、列表推导...

取消回复欢迎 发表评论: