python基础（1）——注释

程序文档作用：

1. 用于描述程序并说明它是如何工作的。
2. 标注重点，使别人能看懂你程序，提高团队协作能力。
3. 讲述程序的创作者。

一、单行注释

• 以#开头，#符号后面的内容程序将不再执行。

示例代码如下：

# 这是第一个单行注释
print("hello python")

二、多行注释

• 使用三引号，可用单引号，也可用双引号。
• 如果注释信息很多，一行无法显示，就可以使用多行注释。

示例代码如下：

'''
这是第一段一段注释
'''

"""
这是第二段注释
"""

正确使用代码注释：

1. 注释尽量追求简洁性，使注释能一读就懂，提高代码可读性。
2. 对于简单代码不必添加注释。
3. 对于逻辑性强的代码应该详细编写注释详解，整理清楚代码逻辑结构，提高代码质量。

相关文献：https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/#comments

任何语言的程序员，学会如何编写程序文档，是学习编程语言的第一步！