Python 注释

简述

对于任何编程语言来说,都可以在代码中包含注释。这不仅有助于解释代码以提高可读性,也便于日后自己参考或者他人阅读,有时对跟踪问题也非常有用。

添加注释很有必要,好的开发人员基本都会大量地使用注释。

  • 简述
  • 注释风格
    • 单行注释
    • 多行注释

版权所有:一去丶二三里,转载请注明出处:http://blog.csdn.net/liang19890820

注释风格

在 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 代码。

时间: 2024-09-24 20:41:36

Python 注释的相关文章

Python编程入门的一些基本知识

  这篇文章主要介绍了Python编程入门的一些基本知识,包括注释需和Shell命令使用等基本内容,要的朋友可以参考下 Python与Perl,C和Java语言等有许多相似之处.不过,也有语言之间有一些明确的区别.本章的目的是让你迅速学习Python的语法. 第一个Python程序: 交互模式编程: 调用解释器不经过脚本文件作为参数,显示以下提示: ? 1 2 3 4 5 $ python Python 2.6.4 (#1, Nov 11 2014, 13:34:43) [GCC 4.1.2 2

Python基础一(基本类型和运算符)

在说Python的基本类型钱我们先说下Python注释方式有哪几 Python注释 行注释 #行注释 行注释用以#开头,#右边的所有文字当做说明,而不是真正要执行的程序,起辅助说明作用 # 我是注释,可以在里写一些功能说明之类的哦 print('hello world') 块注释 "'块注释"'或者"""快注释""" 块注释用三个单引号或者三个双引号包围,引号中的文字当做说明,而不是真正要执行的程序,起辅助说明作用 '''我是

Python 快速入门

学习 Python 的由来 第一次接触 Python 时,是在刚毕业不久,那时公司需要做一个网盘客户端,需要调研一些 GUI 框架.由于当时 Python 很火(当然,现在也一样),便尝试了一下 PyQt(Python 语言和 Qt 库的融合),后面的事情就不再多说了...我变成了一个 Qter. 很长时间里,我对 Python 的认知停留在"Life is short, You need Python "上,就像"PHP 是世界上最好的语言"一样.直到去年的一次&

Python开发者面向文档编程的正确姿势

概述 秦人不暇自哀,而后人哀之;后人哀之而不鉴之,亦使后人而复哀后人也! –论面向文档编程的重要性 如果想看见识一个人写代码的功力,注释其实是区分老司机和小鲜肉的一个显著的分界线(有没有观察到你们公司的领导基本都在开会或者写文档),通常情况下老司机的文档量与代码量是1:1的比例,而新人往往认为写完功能模块就已经可以完成任务了.生产环境中需要面对现实中大量复杂的业务逻辑和数据校验并与各方对接,文档质量和代码质量就被提升到了相同的高度.很多人没有写注释的习惯,大多数不是因为懒惰,一方面是没有意识到写

《Python数据科学实践指南》——2.4 流程控制

2.4 流程控制 到目前为止,我们所编写的程序都是线性的程序,程序中的语句按照顺序依次被执行,这样的程序能实现的功能非常有限,而且还需要编写大量的代码,损失了编写程序执行任务的大部分优势.事实上,可以使用条件判断及循环这两种常用的方式更有效率地编写程序. 2.4.1 条件判断 带有条件判断的程序又称为"分支程序",这样的程序由如三个部分构成. 这样的代码可以执行某些规则的比较,比如下面这段程序: if sex == "man": print("he&quo

《Python数据科学实践指南》一2.4 流程控制

2.4 流程控制 到目前为止,我们所编写的程序都是线性的程序,程序中的语句按照顺序依次被执行,这样的程序能实现的功能非常有限,而且还需要编写大量的代码,损失了编写程序执行任务的大部分优势.事实上,可以使用条件判断及循环这两种常用的方式更有效率地编写程序. 2.4.1 条件判断 带有条件判断的程序又称为"分支程序",这样的程序由如三个部分构成. 一个条件判断,对一个表达式求值,结果是True或False. 一个代码块,如果条件判断为True,则执行这部分代码. 一个可选的代码块,如果条件

短文本分析----基于python的TF-IDF特征词标签自动化提取

绪论 最近做课题,需要分析短文本的标签,在短时间内学习了自然语言处理,社会标签推荐等非常时髦的技术.我们的需求非常类似于从大量短文本中获取关键词(融合社会标签和时间属性)进行用户画像.这一切的基础就是特征词提取技术了,本文主要围绕关键词提取这个主题进行介绍(英文). 不同版本python混用(官方用法) Python2 和python3 是一个神一般的存在,如何让他们共存呢,直到我用了pycharm我才知道为啥这么多人选择它,如下图所示配置两个目录直接可以混用了,叼炸天. 插播一个广告,想修改p

《Python数据科学实践指南》——2.4节流程控制

2.4 流程控制到目前为止,我们所编写的程序都是线性的程序,程序中的语句按照顺序依次被执行,这样的程序能实现的功能非常有限,而且还需要编写大量的代码,损失了编写程序执行任务的大部分优势.事实上,可以使用条件判断及循环这两种常用的方式更有效率地编写程序.2.4.1 条件判断带有条件判断的程序又称为"分支程序",这样的程序由如三个部分构成.一个条件判断,对一个表达式求值,结果是True或False.一个代码块,如果条件判断为True,则执行这部分代码.一个可选的代码块,如果条件判断为Fal

提高代码可读性的十大注释技巧分享_相关技巧

本文讲述了提高代码可读性的十大注释技巧.分享给大家供大家参考,具体如下: 很多程序员在写代码的时候往往都不注意代码的可读性,让别人在阅读代码时花费更多的时间.其实,只要程序员在写代码的时候,注意为代码加注释,并以合理的格式为代码加注释,这样就方便别人查看代码,也方便自己以后查看了.下面分享十个加注释的技巧: 1. 逐层注释 为每个代码块添加注释,并在每一层使用统一的注释方法和风格.例如: 针对每个类:包括摘要信息.作者信息.以及最近修改日期等: 针对每个方法:包括用途.功能.参数和返回值等. 在