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

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

off999 2024-10-09 14:06 18 浏览 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中的两个内置函数id()和type()

id()>>>id(3)2531362761072>>>id(3.222222)2531397393680>>>id(3.0)25313...

python 函数中,如何将另一个函数作为参数传递

python函数中,如何将另一个函数作为参数传递,类似C#委托defadd(a,b):"""这是一个简单的加法函数,接受两个参数并返回它们的和。""...

Python性能暴涨10倍的终极指南:7个核心技巧+代码压缩秘籍

提升Python程序运行性能,使代码运行更流畅更快,以及压缩代码,减小代码大小,下面的方法仅供大家参考,有什么更好的方法在评论区说说。1.使用NumPy/SciPy替代纯Python循环...

Python 匿名函数(Lambda 函数)详解

匿名函数(AnonymousFunction),在Python中称为lambda函数,是一种不需要使用def关键字定义的小型函数。它主要用于简化代码,特别适合需要函数对象的地方。1.基...

Python学习笔记 | 匿名函数lambda、映射函数map和过滤函数filter

什么是匿名函数?定义:没有函数名的自定义函数场景:函数体非常简单,使用次数很少,没有必要声明函数,通常搭配高阶函数使用。高阶函数是能够把函数当成参数进行传递的函数,如:映射函数map和过滤函数fil...

python练习:自定义函数调用:商品购物实例

1、商品录入dict_myshanpin_iof={101:{"商品名称":"毛毛熊","单价":25},102:{"商品名称":...

Python中如何使用Lambda函数(lambda在python中的用法)

Python和其他编程语言一样,都在其语法中添加了lambda函数,Pythonlambda是匿名函数,比常规Python自定义函数有更简洁的语法。虽然Lambda语法在开始时可能会觉得有点混乱,...

8-Python内置函数(python内置函数代码)

Python提供了丰富的内置函数,这些函数可以直接使用而无需导入任何模块。以下是一些常用的内置函数及其示例:1-print()1-1-说明输出指定的信息到控制台。1-2-例子2-len()2-1-说...

用Python进行函数式编程(python函数程序)

什么是函数式编程?函数式程序设计是一种编程范例,它把计算当作数学函数的评价,避免状态和可变数据。换句话说,函数编程(FunctionalProgramming,FP)促进没有副作用和不变变量的代码。它...

python 函数进阶(python如何进阶)

1.有名函数和匿名函数#该函数有名称,名称是adddefadd(x,y):returnx+y#改函数没有名称属于匿名函数,也叫lambda表达式lambda_add...

python自学者的分享:自定义函数、参数作用域、匿名函数、装饰器

#自定义新函数函数名newhsdefnewhs(a,b=1):#b的默认值为1,在没有传入b值时,采用默认值,,默认值参数不能放前边returna-bprint(newh...

Python 函数式编程的 8 大核心技巧,不允许你还不会

函数式编程是一种强调使用纯函数、避免共享状态和可变数据的编程范式。Python虽然不是纯函数式语言,但提供了丰富的函数式编程特性。以下是Python函数式编程的8个核心技巧:1.纯函数(...

零基础到发布:手把手教你创建并分发 Python 自定义库

作为程序员,我们经常依赖各种外部库来解决不同的问题。这些库由技术娴熟的开发者创建,为我们提供了节省时间和精力的解决方案。但你是否曾想过:“我也能创建属于自己的自定义库吗?”答案是肯定的!本文将为你详细...

打工人学Python:(七)自定义函数,打造自己的武器库

从一个简单的函数开始#!/usr/bin/envpython#-*-encoding:utf-8-*-'''@Purpose:Wordcount@...

肖sir_python自定义函数format、zip函数

python自定义函数一、常见的自定义函数已经学过的函数:list、print、set、str、type、tuple、dict、range、input等今天学的函数:format二、实战讲解(一)f...

取消回复欢迎 发表评论: