73 lines
5.2 KiB
Markdown
73 lines
5.2 KiB
Markdown
# python3小白课：注释让你事半功倍
|
||
|
||
> [!question]
|
||
>
|
||
> 注释是啥？
|
||
|
||
大家想想，当我们在学校的时候，拿着课本，老师讲到哪里，我们是不是就在哪里做一下笔记啊？（em...要是你不做笔记，那当我没说）
|
||
|
||
这个笔记就是一种**注释**。
|
||
|
||
在各种编程语言中，注释是一个没什么用但又很有用的东西。它对于实际的代码用处不大，在编译或者解释代码的时候，注释内容会被自动忽略掉，实际执行时不生效。但对于我们开发者来说，堪比代码的说明文档。
|
||
|
||
因为注释内容在实际运行时会被忽略，因此你就可以理解为可以尽情恣意的在代码中编写自己喜欢的注释。
|
||
|
||
> [!question]
|
||
>
|
||
> 注释写点啥呢？
|
||
|
||
嗯，原则是，你想写啥写啥，你还可以写一首诗上去呢哈哈哈。实际上，我们一般会在某几行关键代码的上方、下方、右方等位置编写注释，内容一般写的是这代码是干啥的，有什么注意事项，有什么要点，未来如何维护或者二次开发等等。
|
||
|
||
你写的越详细，对你就越有好处。
|
||
|
||
有的同学说，不用啊，不就那几行简单的代码吗？我记得住，我也都知道它干啥的，费那劲呢写注释。
|
||
|
||
实则不然。对于你自己来说，你今天记得代码是干啥的，明天记得，你能保证三四年之后你再回来看你当时写的代码是什么意思吗？当你的代码量达到成千上万行的时候，你还能清晰的知道你过去写这么多代码的逻辑结构是什么吗？有了注释，这一切就迎刃而解了。对于别人来说，当你的代码需要开源给别人看，或者进行代码团队协作，或者公司里你离职了，新同事需要维护接管你之前写的代码，没有注释，他是不是要直接去看你的代码来理解逻辑呢？因为不同的人实现同一个功能代码结构可能是有差异的，因此没有注释的代码也极其让别人痛苦，无法很好的做二次开发优化。
|
||
|
||
综上所述，注释很重要，能写的部分一定要写，首先是要满足自己知道这是干啥的，其次才是让看你代码的人也能一目了然，而且越详细的注释越有助于别人理解你的代码和你自己记忆起你的代码逻辑。有人说，合理的代码注释应该占源代码的1/3左右，这个你根据自己情况，适量就好。
|
||
|
||
> [!tip]
|
||
>
|
||
> 除了添加内容注释让人明白代码是做什么的，使用注释还有一个功效，就是调试程序，比如一大段代码中，我有几行代码暂时不需要了，但是以后可能需要呀，这时候可以把这几行代码给注释掉，这样解释器在运行py脚本的时候就会忽略了，当我们再需要的时候，取消注释，就可以了。
|
||
|
||
---
|
||
|
||
相信大家在听完前面的内容之后都知道了注释的重要性，那么在python中，注释要怎么写呢？
|
||
|
||
```python
|
||
# coding: utf-8
|
||
|
||
"""
|
||
我是多行注释1，可以用三个双引号括起来
|
||
多行注释这是第二行
|
||
"""
|
||
|
||
'''
|
||
我是多行注释2，可以用三个单引号括起来
|
||
多行注释这是第二行
|
||
'''
|
||
|
||
# 我是单行注释，这一行的所有内容都被视为注释。
|
||
a = 1
|
||
b = 2 # 我是单行注释，#号左边是代码，右边一直到行末都是注释内容，随便写。
|
||
print(a + b) # 比如可以这样写：打印输出a与b的和
|
||
|
||
# 多行注释也可以在每一行的开头加上#号，也算多行注释的一种
|
||
# 许多文本编辑器都有自带的快捷键支持单行或多行注释或取消注释，百度或者看下编辑器的菜单栏即可
|
||
```
|
||
|
||
我们来看一下如上的例子，我们先来说一下后面常规的注释吧。
|
||
|
||
注释的标识符为`#`号，出现它，那么这一行的右侧的内容就会全部被解释器视为注释内容，在执行时会忽略不进行执行。这是一般单行注释的用法。
|
||
|
||
多行注释时，一种办法是可以通过文本编辑器的快捷键，先选中需要注释掉的多行，然后按一下快捷键，批量在前面加上`#`号，如果需要恢复也可以按下快捷键批量变回代码。另一种办法是使用上述代码中介绍到的多行注释的方法，使用单引号或双引号均可，效果一致，可以看你喜欢。当我们定义多行文本字符串的时候，也是用的这种方法。
|
||
|
||
咱们再来看一下开头的第一行代码，前面也有一个`#`号，那它是注释吗？其实也是注释的，为啥我们都需要写它呢？它的作用其实是给解释器标注脚本的编码格式，在python2中，如果不标注它，则默认代码是ascii编码的，所以需要写一下它是utf-8编码，否则解释器会报错，也不能正常处理中文。
|
||
|
||
> [!tip]
|
||
>
|
||
> 在python3中，默认的脚本编码格式就是utf-8编码，因此理论上在python3中，不写它也不会报错，也能正常处理中文。但为了代码的可移植性，还是建议习惯性都写上会比较好。编码格式的定义一般写在py文件的第一或第二行。其实你就跟着我写就可以了。
|
||
|
||
关于文件编码声明的更多详细标准内容，可以查阅官方文档做延伸阅读：
|
||
|
||
[https://www.python.org/dev/peps/pep-0263/](https://www.python.org/dev/peps/pep-0263/) |