python 中的注释

单行注释

# 这里是注释
# 单行 以 # 开头会被识别为注释

多行注释

"""
三个引号包可以包含多行文本，本质上是多行字符串
当没有进行赋值时，为注释，常用在 类说明 方法说明 文件（包） 说明, 这三个位置的 注释 会被 __doc__ 方法获取到
modelName.__doc__
className.__doc__
funcName.__doc__
"""
class A(object):
    """
    这里是类说明
    """
    def func(self, a, b):
        """
        这里是方法说明，函数一样
        :param a: a
        :param b: b
        :return: a + b
        """
        return  a + b
print(A.__doc__) # 输出： 这里是类说明