三大文档字符串（注释）及查看

• 好的代码需要有良好的注释，而我貌似从来不太关注这些，所以我特意总结了Python的模块、类以及函数（类中叫方法）的注释怎么写怎么看，感觉有用。

• 模块的注释

  • Python的模块就是一个.py文件，它的注释要紧挨着Python解释器以及编码声明语句后、其它代码之前。模块注释的写法就是用三引号括起来的一段文字。
  • 引用模块时，将鼠标放在模块上就会显示注释信息了。

• 类的注释

  • 类的注释用于解释类的行为，书写方式与模块的注释一样，在类的最上面用三引号括起来即可。
  • 引用类时，将鼠标放在类上显示注释信息。

• 方法的注释

  • 方法包括类的构造方法、类方法或者实例方法 ，他们的注释基本一样，唯一的区别是不需要对构造方法和实例方法的self参数书写注释，因为在调用这类方法的时候根本就看不到self参数。
  • 引用方法时，将鼠标放在方法上显示注释信息。

import math

# 定义一个类
'''
我是数学模块说明文档，定义模块时对模块说明时使用

'''

class study():
    '''
    我是关于数学学习的类的说明文档
    '''

    def __init__(self):
        '''
        我是构造方法的说明
        '''
        print("To learn math")

    def primary(self):
        '''
        我是实例方法的说明
        '''
        print("+ - * /")

# 定义一个普通函数
def senior(a,b):
    '''
    我是函数的说明
    :param a: a是啥
    :param b: b是啥
    :return: 返回啥
    '''

stu = study()  # 实例化
stu.primary()  # 调用函数

'''
Python中的 文档字符串（docString） 出现在 模块、函数、类 的第一行，用于对这些程序进行说明。它在执行的时候被忽略，但会

被编译器存放到 模块、函数、类 的__doc__属性中。不过，并非每一个模块、函数、类都有文档字符串。
'''
print(math.__doc__)  # 输出模块的说明文档,这里打印系统中对导入模块的说明文档，而非自己写的描述，用help(math)可以产看到系统中的description
print(stu.__doc__)  # 输出类的说明文档
print(stu.primary.__doc__)  # 输出方法的说明文档
help(senior)       # 输出函数的说明文档

• 以下是输出

To learn math
+ - * /
This module is always available.  It provides access to the
mathematical functions defined by the C standard.

    我是关于数学学习的类注释
    

        我是实例方法的注释
        
Help on function senior in module __main__:

senior(a, b)
    函数的注释写这里
    :param a: a是啥
    :param b: b是啥
    :return: 返回啥

• 目前不知道如何输出普通注释的信息，和调用模块时自己备注的信息，如有知道，欢迎评论