如何在python中加注释的简单介绍

发布时间:2022-11-15

本文目录一览:

1、python三种注释方法
2、Python中如何添加注释?
3、「Python编程规范」为Python代码添加注释

python三种注释方法

python三种注释方法: 方式1:

  • 单行注释:shift + #(在代码的最前面输入,非选中代码进行注释)。
  • 多行注释:同单行一样在每一行的前面输入shift + #。 相关推荐:《Python视频教程》 方式2:
  • 单行和多行一样的方式:Ctr+ /(前提是选中需要注释的代码)。 方式3:
  • 输入 ''' 或者 """,将要注释的代码插在中间。

Python注释好处:

  1. 增强代码的可读性。
    由于个人编码的习惯不同,可能我们自己写的代码不是所有人都能读懂。但是在团队合作的项目里又是必须互相都需要看懂的,所以这个时候注释就更利于团队之间的交流合作和代码的拼接。
  2. 方便找出代码的bug。
    很多时候我们的代码无法运行,这个时候我们就可以通过注释的方法来看哪一行代码出了问题,这样更利于检查代码的bug。

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编程有浓厚的兴趣,希望这篇文章可以为您提供帮助。如果您还想了解更多关于Python编程的技巧及素材等内容,可以点击本站的其他文章进行学习。

「Python编程规范」为Python代码添加注释

功能要求

为Python代码添加注释,对Python程序代码进行说明。

实例代码

'''
多行注释开始
下面的代码根据变量x的值计算y
注意代码中使用缩进表示代码块
多行注释结束
'''
x = 5
if x > 100:
    y = x * 5 - 1  # 单行注释:x>100时执行该语句
else:
    y = 0  # x <= 100时执行该语句
print(y)  # 输出y

运行结果

知识说明: 注释用于为程序添加说明性的文字,帮助程序员更好的阅读和理解程序代码。Python解释器会忽略注释的内容,即注释的内容不会被Python解释器执行。 Python注释分为单行注释和多行注释。

  • 单行注释 以符号 # 开始,当前行中符号 # 及其后的内容为注释语句。单行注释可以独占一行,也可放在语句末尾。

    说明:在Pycharm中使用 Ctrl + / 可以添加/取消单行注释。

  • 多行注释 是用3个英文单引号 '''多行注释文本''' 或3个双引号 """注释文本""" 进行注释。

    注意:由一对三个单引号或一对三个双引号括起来的内容被认为是注释,但不能由三个单引号和三个双引号混合使用。