三大文檔字符串（註釋）及查看

• 好的代碼需要有良好的註釋，而我貌似從來不太關注這些，所以我特意總結了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: 返回啥

• 目前不知道如何輸出普通註釋的信息，和調用模塊時自己備註的信息，如有知道，歡迎評論