Python中的注释
Python
注释的语法
- 在 Python 中，使用
#标记进行单行注释。 - 使用
"""或'''来进行多行注释。 - 多行注释不能嵌套。
- 注释不会被 Python 解释器执行。
注释的作用
- 代码注释最重要的作用就是让读者可以在不读源码的情况下，快速了解一段代码的主要功能。
- 注释是提高代码可读性的重要手段。
# -*- coding: utf-8 -*-
# 注释不会运行
print('hello world')在 VS Code 中快速编写注释
使用 Ctrl+/ 热键进行单行注释，使用 Ctrl+Shift+/ 热键可以进行多行注释。对于 Mac 电脑，应使用 Cmd 而不是 Ctrl，使用 Option 而不是 Shift。
Python 鼓励每一行使用一句独立语句从而使得代码更加可读。
如何编写注释
John Ousterhout在《A Philosophy of Software Design》一书中提到，写注释最好的时机是在写代码之前。这样，注释就相当于一种设计工具：在编码前通过注释描述这段代码的功能，然后在通过编码实现这个功能，如果这个过程有偏差，则再调整注释。
训练有素的程序员都希望代码中包含注释，因此你最好从现在开始就在程序中添加描述性注释。作为新手，最值得养成的习惯之一就是在代码中编写清晰、简洁的注释。
如果程序太简单，实在没有什么需要说明的，就在程序文件开头加上你的姓名和当前日期，再用一句话阐述程序的功能。
小结
- 注释有单行和多行两种。
- 注释的读者是同事、同行以及今后的自己，需要言之有物。