注释的使用|学习笔记

简介: 快速学习注释的使用

开发者学堂课程【Python 入门 2020年版注释的使用】学习笔记,与课程紧密联系,让用户快速学习知识。

课程地址:https://developer.aliyun.com/learning/course/639/detail/10231


注释的使用

 

内容介绍

一、提出问题

二、怎么说明

三、注释的分类

四、快捷键说明

五、注释的作用

 

 

一、提出问题

例:print (‘hello world’)右键运行出来在控制台中会显示 hello world,这个代码到底是起到何种作用,需要对这段代码进行说明。

 

二,怎么说明?

1. “#+注释则为对本段代码进行解释”,井号后的全部内容都是对代码的解释,全是注释。

例:#在控制台里打印 hello world,,就是对前方代码进行解释说明。

2. # 表示的是一个注释,注释的目的:是为了对代码进行说明,注释是给程序员看的,给人看的,害怕别人看不明白你的代码所写的内容,解释器不看注释。

3.#表示的是单行注释,只对本行有效 ,如果换行就会报错。

例:#表示的是单行注释

Yes

print (‘hello world’)

中 yes 就会报错

 

三、注释的分类

1. 单行注释:以#开头,#右边的所有东西当做说明,而不是真正要执行的程序,起辅助说明作用

2. 多行注释:’’’以三个单引号开始,以三个单引号结束,

中间内容是注释,允许换行。

(三个双引号也是可以的,一般情况下使用三个单引号)

’’’

例:

“““

我也是

多行注释

”””

 

四、快捷键说明

如果不想使用注释了,除了可以手动删除/添加井号注释以外,还可以使用快捷键‘ctrl+/’ 来给代码添加或删除注释。

若想使用大段注释全部删除/添加注释,即可全选该段注释,再使用快捷键‘ctrl+/’来给其删除/添加注释。

在 python 中有很多有趣的快捷键,在以后会学习到。

 

五、注释的作用

在我们工作编码的过程中,如果一段代码的逻辑比较复杂,不是特别容易理解,可以适当的添加注释,以辅助自己或者其他编码人员解读代码。

程序源代码中的注释经常是一个卧虎藏龙的地方,有人就很喜欢写幽默搞笑的注释内容,解释代码含义的同时,也带给人轻松神经的机会,以下是国外某公司产品中的注释。

image.png

以上注释在说,这段代码有问题,想要修改它,但是折腾很久之后,花了很长时间,但是最后还是没有处理好。就好比你去了一家公司,代码写的很烂,很难看,但是你又不得不去处理这段代码,你需要耗费大量时间和精力去处理上一个人所遗留的问题,虽然代码难看,但是又是不可缺少的,是因为在代码架构的时候没有处理好,会产生一系列问题,但是又改不了。

image.png

以上是一些幽默有趣的注释

接下来是比较真实的注释:

例:我们使用的“print”是用来打印的,但具体如何使用呢?想看一下 print 有没有注释呢?

其实是可以的,在 pycharm 工具中,可以查看一下 print 的注释。按住 ctrl 键不放,用鼠标左键点击 print,当鼠标放在 print 上时会出现一个小手,点击小手,就会进入 print 的注释,显示三个双引号的多行注释,告诉你如何使用。

相关文章
|
5月前
DTL注释
DTL注释。
35 1
|
1天前
|
Java 编译器 C语言
2.2 注释
在编程中,/*与*/间的部分为注释,帮助他人理解程序。C语言支持多行及同行为代码添加注释,如/*这是C注释*/。C99引入了类似C++和Java的//注释方式,仅限单行://这是单行注释。甚至 int range;//此处也可注释。但需注意避免注释缺失结束标记导致的错误。
|
2月前
注释
【8月更文挑战第6天】注释。
32 2
|
5月前
|
算法 编译器 C++
C++注释
C++注释
30 2
|
5月前
|
存储 弹性计算 运维
使用注释
【4月更文挑战第29天】
23 2
|
5月前
|
编译器 C++
C++ 注释
C++ 注释
31 0
|
5月前
|
XML 程序员 编译器
C#注释
C#注释
66 0
|
编译器 C++
C++ 注释
【摘要】 C++ 注释程序的注释是解释性语句,您可以在 C++ 代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C++ 支持单行注释和多行注释。注释中的所有字符会被 C++ 编译器忽略。C++ 注释一般有两种:// - 一般用于单行注释。/* ... */ - 一般用于多行注释。注释以 // 开始,直到行末为止。例如:实例#include <iostream>using n...
|
程序员
笑出腹肌的注释,就怕你不敢用!
笑出腹肌的注释,就怕你不敢用!
105 0
笑出腹肌的注释,就怕你不敢用!