Loading... 各位同学们大家好，我是雪山凌狐，欢迎学习 python3 小白课。 在开始这节课之前，我请大家先思考一个问题：当我们在学校念书的时候，老师在讲台上讲着课，我们是不是就在课桌上认真的做笔记呀？这里假设咱们是一个认真听课做笔记的同学。这时候呢，在原有印刷的内容旁边写上的笔记就是我们所说的注释啦。 在各种编程语言中，我们都可以编写注释内容，这个注释内容呢，在实际执行代码的时候会被忽略掉，不管你写什么，都不会执行。对于我们开发者来说，就是代码的说明文档。由于注释的内容在实际执行代码时会被忽略，因此你可以按照你的需要尽情编写注释内容。 那么我们说，注释到底写点什么好呢？通常来说，我们一般会在某几行关键代码的上方、下方、右方等位置编写注释，内容一般写的是这代码是干啥的，有什么注意事项，有什么要点，未来如何维护或者二次开发等等。注释越详细，代码的可读性就会越强。 有的同学说，不用啊，不就那几行简单的代码吗？我记得住，我也都知道它们干啥的，不写注释对我来说还能省点时间呢。 这时候就不得不跟大家谈谈注释的一些很有价值的功效了。 我们总结了下面几点： 第一，对于你自己来说，你今天记得代码是干啥的，明天记得，你能保证三四年之后你再回来看你当时写的代码是什么意思吗？而当你的代码量达到成千上万行的时候，你还能清晰的知道你过去写这么多代码的逻辑结构是什么吗？所以，有注释最重要的一点，是服务于遗忘的你自己。 第二，对于别人来说，有几个场景，当你的代码需要开源给别人看的时候，当需要进行项目代码团队协作的时候，当你在一个岗位离职，新同事需要继续维护你之前写的代码的时候，没有注释该是怎样的？那一定会让别人看的极其的痛苦，甚至需要通过直接阅读你的代码来分析出编写的逻辑。而不同的人实现同一个功能的代码逻辑是完全可能不一样的，因此没有注释的代码会很难进行维护和二次开发。所以对别人来说，就是便于代码交流。 第三，我们在测试一大段代码的时候，偶尔有几行代码我们暂时不需要执行它们，这时候直接删除它们绝不是一个好的选择，因为可能只是临时性用不到它们，测试完成后还需要的。这时候你就可以把这几行代码设置为注释，这时候 python 解释器就不会执行它们了，当测试结束之后，发现这几行代码我们还需要，只需要取消这几行代码的注释，使之生效，就可以了，非常便捷。 综上所述，编写注释很重要，能写的部分一定要写。有人说，合理的代码注释应该占源代码的 1/3 左右，这个你根据自己的情况，适量就好。 相信大家在听完前面的内容之后都知道了注释的重要性，那么在 python 中，注释要怎么写呢？我们来看一下如下这个小例子： ```python # coding: utf-8 """ 我是多行注释1，可以用三个双引号括起来 多行注释这是第二行 """ ''' 我是多行注释2，可以用三个单引号括起来 多行注释这是第二行 ''' # 我是单行注释，这一行的所有内容都被视为注释。 a = 1 b = 2 # 我是单行注释，#号左边是代码，右边一直到行末都是注释内容，随便写。 print(a + b) # 比如可以这样写：打印输出a与b的和 # 多行注释也可以在每一行的开头加上#号，也算多行注释的一种 # 许多文本编辑器都有自带的快捷键支持单行或多行注释或取消注释，百度或者看下编辑器的菜单栏即可 ``` 上述小例子咱们从下网上看哈。在 python 中，我们使用井号 `#` 来表示注释的开头，使用这个标识符之后呢，会使得这一行该符号右边的全部内容都变为注释内容，去掉井号之后，就变回代码内容，解释器会进行解释。但井号只能管一行，如果你的注释内容很长，需要好几行才能打完或者好几行打出来比较好看的话，就需要用到多行注释了。一种简便的办法是，在一些增强型编辑器中，将需要作为注释的行选中然后按下对应的快捷键，比如在 vscode 中就是 `ctrl+/` 可以让选中行在代码和注释中进行切换。 如果你不想使用这种方式，你可以像上述内容一样，使用三个双引号或者三个单引号来将内容引起来，至于用哪种引号按你的喜好来即可。这时候就可以编写多行注释了，是不是也很方便呐？ 最后我们再来关注一下第一行的代码，它的开头想必同学们已经发现了也有一个井号，那么它，是不是注释呢？其实严格来说也是注释，而且是一种特殊的注释。那么为啥我们都需要写它呢？它的作用啊其实是给解释器标注脚本的编码格式，在 python2 中，如果不标注它，则默认代码是 ASCII 编码的，所以需要写一下它是 utf-8 编码，否则解释器会报错，也不能正常处理中文。在 python3 中，默认的脚本编码格式就是 utf-8 编码，因此理论上在 python3 中，不写它也不会报错，也能正常处理中文。但为了代码的可移植性和避免未知的错误，还是建议习惯性都写上会比较好。 关于文件编码声明的更多详细标准内容，如果你感兴趣的话，可以查阅官方文档做延伸阅读： [https://www.python.org/dev/peps/pep-0263/](https://www.python.org/dev/peps/pep-0263/ "https://www.python.org/dev/peps/pep-0263/") 好的，本节课的内容就到这里啦～ 你的支持和理解也是我继续出课程的最大动力~ 如果你觉得本套教程不错的话，欢迎点赞、评论和收藏哟~ 更多精彩视频教程，欢迎全网搜索 “雪山凌狐教程”，我们下节课，再见！ 以下是我们的视频教程： **在线观看：** https://www.bilibili.com/video/BV1jD4y1X71h/ **高清源文件下载：** <div class="hideContent">该部分仅登录用户可见</div> 希望大家加油学习，我们下次再见！ 最后修改：2021 年 08 月 20 日 © 允许规范转载 赞 赠人玫瑰，手留余香
