注释

• 注释不属于程序执行部分，不会影响程序运行，仅用来给程序员阅读代码做说明。
• Python执行代码时，会自动跳过注释内容。
• 使用 # 井号写单行注释，# 后面本行所有内容都会被Python忽略。

几种写法示例

# 这是单独一行注释
name = "Jack"  # 行尾注释，写在代码同一行的后面

# >>> "This is a string"
# 'This is a string'
# >>> # This is a comment
# >>> "This is a string" # with a comment at the end
# 'This is a string'

# 注意：字符串里面的 # 只是普通文本，不是注释
print("# Here is a pound sign within a string, being treated as a string!")Code language: PHP (php)

注意

1. 单独一行写#注释：Python直接跳过，继续执行下一行代码。
2. 注释大多写在.py程序文件中；交互式终端里写的注释不会被保存。
3. 调试小技巧：可以把暂时不想运行的代码前面加上#注释掉，用来排查错误、观察代码效果。
4. 字符串引号内部的#，只是普通字符，不会当成注释。

函数文档字符串

#是单行注释；函数开头三引号"""..."""是文档字符串(docstring)，可以被工具读取提取帮助信息。

def calc_sum(a,b):
    """计算两个数字相加，返回相加结果
    :param a: 第一个数字
    :param b: 第二个数字
    :return: a + b 的计算结果
    """
    return a + bCode language: PHP (php)

#注释 和 docstring文档字符串区别

• #：普通注释，给人看，程序工具一般不会提取。
• 函数开头三引号docstring：属于函数对象一部分，可以用help(函数名)查看帮助文档。

总结

1. #开启单行注释，本行#之后全部忽略。
2. 字符串内部的#不会生效。
3. 注释只用于阅读、调试，对程序运行无任何作用。
4. 函数说明优先用文档字符串，代码行简短说明用#注释。