Python入门基础系列(五)——单行和多行注释

原创 2018年04月16日 22:29:20

注释就像使得指定的代码不言而喻并具有高度可读性的路标。在Python中,我们可以添加单行和多行Python注释。这篇文章将详细介绍这两种方法。阅读完这些之后,您将知道如何添加Python注释以及使用哪种样式的注释。

写注释是一种很好的编程习惯。它们是代码中不可执行的部分,但在程序中非常重要。这些不仅可以帮助其他程序员在同一个项目上工作,而且测试人员还可以参考白盒测试的清晰度。最好在创建或更新程序时添加注释,否则可能会丢失上下文。后面写的注释可能不如他们应该那样有效。

Python入门基础系列(五)——单行和多行注释

在这里我还是要推荐下我自己建的Python开发学习群:483546416,都是学Python开发的,如果你正在学习Python ,小编欢迎你加入,今天分享的这个案例已经上传到群文件,大家都是软件开发党,不定期分享干货(只有Python软件开发相关的),包括我自己整理的一份2017最新的Python零基础资料和Python进阶教程,欢迎进加入

接下来我们带着下面这几个问题进入学习当中。

1.如何在Python中使用注释?

2.如何在Python中使用单行注释?

3.如何在Python中使用多行注释?

使用散列标记进行注释?

4.如何在Python中使用docstrings?

对文档字符串使用三引号标记

docstring与Python中的注释

5.Python注释,多行注释和DocString

注释是一种表达程序将在非常高级别上做什么的艺术。这些标记的文本行用于注释一段代码。在Python中,我们可以应用两种风格的评论:单行和多行。

单行Python注释

当需要简短快速的调试注释时,您可能更喜欢使用单行Python注释。单行注释以(#)符号开头,并自动以EOL结尾(行尾)。养成良好的代码编写习惯。

print("Learn Python Step by Step!")

在发表注释时,请确保您的注释与其下面的代码具有相同的缩进级别。例如,您可能注释了一个没有任何缩进的函数定义。但是该函数可能有多个级别缩进的代码块。因此,当您在内部代码块中进行注释时,请注意对齐。

Python入门基础系列(五)——单行和多行注释

多行Python注释

Python允许注释跨越多行。这些注释被称为多行或块注释。您可以使用这种注释风格来描述更复杂的内容。这种扩展形式的注释适用于以下部分或全部代码。以下是使用多行Python注释的示例。

使用散列(#)标记

要添加多行注释,您应该开始每行使用(#)符号,后跟一个空格。您可以将注释分成段落。只需在每个段之间添加一个带有散列标记的空行。

注意: 符号(#)也被称为八足形。这个术语来自贝尔实验室的一组工程师,他正在研究第一个按键式键盘项目。

#要学习任何语言,您必须遵循以下规则。

1.了解基本语法,数据类型,控制结构和条件语句。

2.学习错误处理和文件I / O。

3.阅读有关高级数据结构

4.编写函数并遵循OOP概念。

Python中的Docstring

Python具有文档字符串(或文档字符串)功能。它为程序员提供了一种简单的方法来为每个Python模块,函数,类和方法添加快速笔记。您可以通过将其添加为字符串常量来定义文档字符串。它必须是对象(模块,函数,类和方法)定义中的第一条语句。文档字符串的范围比Python注释的范围更广。因此,它应该描述该功能的功能,而不是如何。另外,程序的所有功能都有一个文档字符串是一种很好的做法。

如何在Python中定义Docstring?

您可以借助三引号标记定义文档字符串。在开头添加一个,在字符串的末尾添加一个。就像多行注释一样,docstring也可以重叠到多行。

注意:使用三引号标记定义的字符串是Python中的docstring。但是,您可能会认为这是常规注释。

注释和文档字符串有什么区别?

以三重引号开头的字符串仍然是常规字符串,除了它们可以传播到多行。这意味着它们是可执行语句。如果它们没有标记,那么只要代码执行,它们就会被垃圾回收。

Python解释器不会像注释那样忽略它们。但是,如果将这样的字符串放在函数或类定义之后,或者放在模块之上,那么它们会变成文档字符串。您可以使用以下特殊变量来访问它们。

myobj.__doc__.__doc__

例:

Python入门基础系列(五)——单行和多行注释

注释和文档字符串为程序添加值。它们使您的程序更具可读性和可维护性。即使您稍后需要重构相同的代码,那么使用可用的注释也会更容易。软件在开发过程中只花费10%的时间,在维护中花费90%的时间。因此,总是会提供相关且有用的注释或文档,因为它们会导致更多的协作并加速代码重构活动。

如果你今天学到了新的东西,那么别介意进一步分享它。并且可以关注我后续一系列Python的相关文章。

游戏开发入门系列(TX Class)

你知道的TX Game课程介绍游戏技术发展游戏开发流程游戏程序员是怎样炼成的保持对游戏的浓厚兴趣和激情主动学习所有细节通过课程了解专业技能概况,掌握学习方法通过实战磨练和验证成果游戏技术的发展pong...
  • wangjun_huster
  • wangjun_huster
  • 2017-06-07 17:35:34
  • 288

爬虫入门系列(六):正则表达式完全指南(下)

爬虫入门系列目录: 爬虫入门系列(一):快速理解HTTP协议 爬虫入门系列(二):优雅的HTTP库requests 爬虫入门系列(三):用 requests 构建知乎 API 爬虫入门系列(四):...
  • lantian_123
  • lantian_123
  • 2017-09-26 13:14:32
  • 107

1900页Python系列PPT分享一:基础知识(106页)

总体说明:本套PPT共约1900页,包含董付国老师Python系列图书《Python程序设计基础》(2017年7月第5次印刷)、《Python程序设计(第2版)》(2017年9月第4次印刷)、《Pyt...
  • oh5W6HinUg43JvRhhB
  • oh5W6HinUg43JvRhhB
  • 2017-10-30 00:00:00
  • 1892

python 单行注释 多行注释 批量注释 中文注释

Python 中的注释有多种,有单行注释,多行注释,批量注释,中文注释也是常用的。python注释也有自己的规范,在文章中会介绍到。注释可以起到一个备注的作用,团队合作的时候,个人编写的代码经常会被多...
  • dedecms8
  • dedecms8
  • 2017-07-13 15:17:05
  • 517

pycharm单行和多行注释快捷键

单多行注释就一个组合键:选中+Ctrl+/
  • qq_22703355
  • qq_22703355
  • 2018-02-09 08:20:50
  • 183

十五分钟快速入门系列:Python基础

Python是一种面向对象的解释型语言, 源码和解释器CPython遵循 GPL协议。
  • liumiaocn
  • liumiaocn
  • 2017-03-14 19:15:35
  • 1393

Python零基础入门一

上一个寒假学习完了《Android-第一行代码》这本书,这个寒假打算好学习一下python这门语言,一方面是由于对python的爬虫比较感兴趣,另一方面也是算是搜索查找的一种工具。这次学习由于没有找到...
  • BeMoreQuiet
  • BeMoreQuiet
  • 2017-01-09 21:21:34
  • 1961

MySQL---数据库从入门走向大神系列(二)-用Java对MySQL进行增删改查

上节已经学会对MySQL进行简单的增删改查了,那么,我们如何实现用Java来对数据库操作增删改呢。 本节将用Java演示对MySQL进行增删改查。 简单的来说,分为4个步骤: 1、加载连接器(驱动) ...
  • qq_26525215
  • qq_26525215
  • 2016-08-06 15:03:34
  • 5822

Python 正则表达式验证注释(含单行和多行)

//[^\r\n]*|/\*.*?\*/ Option: Dot match line break
  • guaguastd
  • guaguastd
  • 2014-09-23 09:46:10
  • 1306

Java正则表达式的多行匹配实战-将java文件中的单行和多行注释内容替换为空

我们知道java中有三种注释方式 1. //  单行 2. /* .......*/   单行 或多行 3. /** .......*/ 单行 或多行 我们的目的就是把以上三种特征的注释替...
  • hongqishi
  • hongqishi
  • 2013-06-27 18:43:43
  • 4069
收藏助手
不良信息举报
您举报文章:Python入门基础系列(五)——单行和多行注释
举报原因:
原因补充:

(最多只允许输入30个字)