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

Python中如何写注释(python中怎么全部加注释)

off999 2024-10-09 14:06 37 浏览 0 评论

不论我们编写什么程序,写注释是一个很好的习惯。这不仅方便自己今后能读懂程序,也方便别人能读懂你的程序。特别是在维护程序时,注释显得特别重要,即使自己写的程序,时间长了,很可能也忘记你的具体思路。

什么地方需要注释

可以在程序的任何地方写注释。一般情况,变量的定义、类的属性、类的方法、算法设计的主要思路、类的作用等需要写注释。

当然,也不是处处都要写注释,处处写注释反而影响了程序的阅读。

Python中的注释


在Python中提供了两种注释方法,分别是单行注释和多行注释。这一点与其他编程语言(如Java,C#等)没有区别。

Python中的单行注释使用"#"字符来开启一行注释。而Python中的多行注释使用一对三个英文单引号或一对三个连写的英文双引号来表示。


Python中的单行注释

“#”字符后的内容为注释内容,且该符号仅对一行起作用。

下面是Python中单行注释的一个例子。

#这里是一个单行注释
print("优雅的代码,vx搜索关注")

num = 8 #定义一个变量存储一个数
if( % 2 == 0): #如果余数为0
    print("是偶数。")
else: #否则为奇数
    print("是奇数。")

Python中的多行注释

多行注释使用一对三个连写的单引号开始,并以三个连写的单引号结束。当然双引号也是可以的。如下面这个例子就是多行注释的情况。

'''
输入一个年份是否为闰年
程序设计:翔宇亭IT乐园
日期:2020-04-12
'''
def isLeapYear():
    #函数的执行语句

在上面这个例子中,单引号也可以换成双引号,要注意,单引号或双引号必须使用英文半角的。

写注释时一些注意事项

在一些实践中,程序注释内容包含程序本身的作用的描述、程序的编写者信息、程序的编写时间、修改时间、修改内容等。

单行注释可以放在一行程序的后面,也可以放在一行程序的上面,但是程序行较长时放在后面不够理想。

尽量使注释的风格保持一致,使阅读者能够顺畅地读取程序。


如果你对Python、R语言等内容感兴趣,欢迎关注我,本号将持续更新相关内容。

相关推荐

第九章:Python文件操作与输入输出

9.1文件的基本操作9.1.1打开文件理论知识:在Python中,使用open()函数来打开文件。open()函数接受两个主要参数:文件名和打开模式。打开模式决定了文件如何被使用,常见的模式有:&...

Python的文件处理

一、文件处理的流程1.打开文件,得到文件句柄并赋值给一个变量2.通过句柄对文件进行操作3.关闭文件示例:d=open('abc')data1=d.read()pri...

Python处理文本的25个经典操作

Python处理文本的优势主要体现在其简洁性、功能强大和灵活性。具体来说,Python提供了丰富的库和工具,使得对文件的读写、处理变得轻而易举。简洁的文件操作接口Python通过内置的open()函数...

Python学不会来打我(84)python复制文件操作总结

上一篇文章我们分享了python读写文件的操作,主要用到了open()、read()、write()等方法。这一次是在文件读写的基础之上,我们分享文件的复制。#python##python自学##...

python 文件操作

1.检查目录/文件使用exists()方法来检查是否存在特定路径。如果存在,返回True;如果不存在,则返回False。此功能在os和pathlib模块中均可用,各自的用法如下。#os模块中e...

《文件操作(读写文件)》

一、文件操作基础1.open()函数核心语法file=open("filename.txt",mode="r",encoding="utf-8"...

栋察宇宙(二十一):Python 文件操作全解析

分享乐趣,传播快乐,增长见识,留下美好。亲爱的您,这里是LearingYard学苑!今天小编为大家带来“Python文件操作全解析”欢迎您的访问!Sharethefun,spreadthe...

值得学习练手的70个Python项目(附代码),太实用了

Python丰富的开发生态是它的一大优势,各种第三方库、框架和代码,都是前人造好的“轮子”,能够完成很多操作,让你的开发事半功倍。下面就给大家介绍70个通过Python构建的项目,以此来学习Pytho...

python图形化编程:猜数字的游戏

importrandomnum=random.randint(1,500)running=Truetimes=0##总的次数fromtkinterimport*##导入所有tki...

一文讲清Python Flask的Web编程知识

刚入坑Python做Web开发的新手,还在被配置臃肿、启动繁琐折磨?Flask这轻量级框架最近又火出圈,凭5行代码启动Web服务的极致简洁,让90后程序员小张直呼真香——毕竟他刚用这招把部署时间从半小...

用python 编写一个hello,world

第一种:交互式运行一个hello,world程序:这是写python的第一步,也是学习各类语言的第一步,就是用这种语言写一个hello,world程序.第一步,打开命令行窗口,输入python,第二步...

python编程:如何使用python代码绘制出哪些常见的机器学习图像?

专栏推荐绘图的变量单变量查看单变量最方便的无疑是displot()函数,默认绘制一个直方图,并你核密度估计(KDE)sns.set(color_codes=True)np.random.seed(su...

如何编写快速且更惯用的 Python 代码

Python因其可读性而受到称赞。这使它成为一种很好的第一语言,也是脚本和原型设计的流行选择。在这篇文章中,我们将研究一些可以使您的Python代码更具可读性和惯用性的技术。我不仅仅是pyt...

Python函数式编程的详细分析(代码示例)

本篇文章给大家带来的内容是关于Python函数式编程的详细分析(代码示例),有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助。FunctionalProgramming,函数式编程。Py...

编程小白学做题:Python 的经典编程题及详解,附代码和注释(七)

适合Python3+的6道编程练习题(附详解)1.检查字符串是否以指定子串开头题目描述:判断字符串是否以给定子串开头(如"helloworld"以"hello&...

取消回复欢迎 发表评论: