前言学会向程序中添加必要的注释,也是很重要的。注释不仅可以用来解释程序某些部分的作用和功能(用自然语言...
Python中注释(多行注释和单行注释)的用法实例
来源:脚本之家
阅读:97
前言
学会向程序中添加必要的注释,也是很重要的。注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),在必要时,还可以将代码临时移除,是调试程序的好帮手。
当然,添加注释的最大作用还是提高程序的可读性!很多时候,笔者宁愿自己写一个应用,也不愿意去改进别人的代码,没有合理的注释是一个重要原因。虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相同的思路。或者一段时间以后,你自己也不清楚当时写这段代码的目的了。
总的来说,一旦程序中注释掉某部分内容,则该内容将会被 Python 解释器忽略,换句话说,此部分内容将不会被执行。
通常而言,合理的代码注释应该占源代码的 1/3 左右。Python 语言允许在任何地方插入空字符或注释,但不能插入到标识符和字符串中间。
在Python 中,通常包括 3 种类型的注释,分别是单行注释、多行注释和中文编码声明注释。
Python单行注释
Python 中使用井号("#")作为单行注释的符号,语法格式为:
# 注释内容
也就是说,从符号"#"处开始,直到换行处结束,此部分内容都作为注释的内容,当程序执行时,这部分内容会被忽略。
单行注释放置的位置,既可以是要注释代码的前一行,例如:
#这是一行简单的注释
print ("Hello World!")
也可以是注释代码的右侧,例如:
print ("Hello World!") #这是一行简单的注释
基于注释在程序中所起到的作用,以上两种方式虽然放置位置不同,但程序的执行结果是相同的,都是输出“Hello World!”。
Python多行注释
多行注释指的是可以一次性注释程序中多行的内容(包含一行)。多行注释的语法有 2 种,分别是:
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
多行注释通常用来为 Python 文件、模块、类或者函数等添加版权、功能描述等信息。需要注意的是,在Python 中,如果多行注释标记(三单引号或三双引号)作为语句的一部分出现,就不能再将它们视为多行注释的标记,而应看做是字符串的标志(同双引号的作用相同),例如:
print("""Hello,World!""")
该语句的执行结果为:Hello,World!。由此可见,Python 解释器没有将这里的三个单引号看做是注释,而是将它们看作是字符串的标志。
Python中文编码声明注释
Python 还提供了一种特殊的中文编码声明注释,其主要用来解决 Python 2.x 中不支持直接写中文的问题。虽然此问题在 Python 3.x 中已经不存在啦,但为了规范编码,增强代码的可执行性,方便其他程序员及时了解程序所用的编码,建议初学者在程序开头处加上中文编码声明注释。
中文编码声明注释的语法有如下 2 种:
# -*- coding:编码 -*-
或者
# coding=编码
语法中的编码,指的是编写程序所用的字符编码类型,比如 UTF-8、GBK 编码等。另外,在第一种语法中,"-*-"并没有实际意义,只是为了美观才加上去了,因此,第一种语法格式中可以直接将前后的"-*-"去掉。
举个例子,如果指定编码为 UTF-8,则可以使用下面的中文编码声明注释:
# coding:utf-8
或者
# coding=utf-8
注意,给代码添加注释是是注释的基本用法,它还有一个更实用的功能,即用来调试程序。举个例子,如果你觉得某段代码可能有问题,可以先把这段代码注释起来,让Python 解释器忽略这段代码,然后运行。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。
由此可见,在调试程序时,学会注释代码,可以缩小错误所在的范围,提高调试程序的效率。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对亿速云的支持。
注释是对一段代码的解释和说明,可提高程序代码的可读性,让人们能够更加轻松地了解代码,尤其在大型项目开发和团队项目中,注释是必不可少的! 任何编程语言都少不了注释,Python也不例外,以下是Python注释的具体...
注释是对一段代码的解释和说明,可提高程序代码的可读性,让人们能够更加轻松地了解代码,尤其在大型项目开发和团队项目中,注释是必不可少的!
任何编程语言都少不了注释,Python也不例外,以下是Python注释的具体用法:
1. 单行注释
Python编程语言的单行注释常以#开头,单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或者表达式之后。
实例:
# -*- coding: UTF-8 -*-
print ("hello world!"); #您好,世界
2. 多行注释
Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记,而实际上这是多行字符串的书写方式,并不是Python本身提倡的多行注释方法。
实例:
这是多行注释,使用单引号。
这是多行注释,使用单引号。
这是多行注释,使用双引号。
这是多行注释,使用双引号。
3. 编码注释
在进行Python开发时,需进行编码声明,如采用UTF-8编码,需在源码上方进行 # -*- coding: UTF-8 -*- 声明,从Python3开始,Python默认使用UTF-8编码,所以Python3.x的源文件不需要特殊声明UTF-8编码。
4. 平台注释
如果需要使Python程序运行在Windows平台上,需在Python文件的上方加上 #!/usr/bin/python 注释说明。
Python注释除了可以起到说明文档的作用外,还可以进行代码的调试,将一部分代码注释掉,对剩余的代码进行排查,从而找出问题所在,进行代码的完善!
对于任何编程语言来说,都可以在代码中包含注释。这不仅有助于解释代码以提高可读性,也便于日后自己参考或者他人阅读,有时对跟踪问题也非常有用。 添加注释很有必要,好的开发人员基本都会大量地使用注释。
简述
对于任何编程语言来说,都可以在代码中包含注释。这不仅有助于解释代码以提高可读性,也便于日后自己参考或者他人阅读,有时对跟踪问题也非常有用。
添加注释很有必要,好的开发人员基本都会大量地使用注释。
|版权声明:一去、二三里,未经博主允许不得转载。
注释风格
在Python 中,注释的风格与其他语言相比有很大的不同,但使用起来也很简单,主要包含两种:
单行注释多行注释
单行注释适用于简短、快速的注释(或者用于调试),而多行注释常用于描述一段内容,或屏蔽整个代码块。
PS:注释是写给其他开发人员(包括自己)看的,Python 解释器会忽略注释。

单行注释

#被用作单行注释符号,使用#时,其右侧的任何数据都会被忽略,被当做是注释。
例如,在代码的上面或下面添加注释:
#print("这是单行注释") print("Hello, World!") #print("这也是单行注释")
这将产生以下结果:
Hello, World!
也可以在代码的后面添加注释:
print("Hello, World!")#这是单行注释
总之,#号右侧的内容是不会被执行的。

多行注释

相比单行注释,多行注释略有不同,需要在想要注释的部分之前和之后添加三个单引号(''')或三个双引号(""")。
例如,描述一段内容,或屏蔽整个代码块:
''' 这在多行注释中 这也在多行注释中 这仍然在多行注释中 '''""" if True: print("Hello") else: print("Python") """ print("Hello, World!")
除此之外,还有一种方式,使用多个单行注释来表示多行注释:
#print("这是注释") #print("这是注释") #print("这是注释") print("Hello, World!")
这种方式适用于简短的代码注释。大多数情况下,相比三引号形式还是略显复杂,一般使用率不高。
建议:注释是我们的好伙伴,应尽量多写,尤其是复杂的 Python 代码。
python中单行注释采用 #开头 [cc lang='python' ] print ‘hellopython’ #this is a comment [/cc] 多行注释 然后python蛋疼的没有块注释,所以现在推荐的多行注释也是采用的 #比如: # comments start #...
python注释的三种方法: 1.井号注释单行代码: # 2.三个单引号或三个双引号注释语句块: ''' 或者" " " 3.井号加两个百分号画出语句块分界线: #%%代码 ''' #data.csv is created by make_data.py data=pd....
1.选中要操作的代码区域 2.按下Ctel+/
注释是对一段代码的解释和说明,可提高程序代码的可读性,让人们能够更加轻松地了解代码,尤其在大型项目开发和团队项目中,注释是必不可少的! 任何编程语言都少不了注释,Python也不例外,以下是Python注释的具体...
我们将介绍编写Python注释的一些基础知识。您将学习如何优雅地编写干净、简洁的注释,以及了解何时您可能根本不需要编写任何注释。 #为什么注释代码如此重要 注释是任何程序的一个组成部分,它们可以以注释块的...
python注释含注释When writing code inPython, it’s important to make sure that your code can be easily understood by others. Giving variables obvious names, defining explicit functions, and ...
多行注释可以用多个#号,还有'''和&...)python最具特色的就是使用缩进来表示代码块,不需要使用大括号{}。缩进的空格数是可变的,但是同一个代码块的语句必须包含相同的缩进空格数。python 的多行语句Py.
在一些简单的程序中只包含Python代码,但随着程序越来越大、越来越复杂,就应在其中添加说明,对你解决问题的方法进行大致的阐述。注释让你能够使用熟悉的自然语言在程序中添加说明,增强程序的可读性。 以下截图是...
python注释也有自己的规范,在文章中会介绍到。注释可以起到一个备注的作用,团队合作的时候,个人编写的代码经常会被多人调用,为了让别人能更容易理解代码的通途,使用注释是非常有效的。